Struct CtrlShutdown
pub struct CtrlShutdown { /* private fields */ }signal only.Represents a listener which receives “ctrl-shutdown” notifications sent to the process via SetConsoleCtrlHandler.
A notification to this process notifies all listeners listening for this event. Moreover, the notifications are coalesced if they aren’t processed quickly enough. This means that if two notifications are received back-to-back, then the listener may only receive one item about the two notifications.
Implementations
impl CtrlShutdown
pub async fn recv(&mut self) -> Option<()>
Receives the next signal notification event.
Although this returns Option<()>, it will never actually return None. This was accidentally exposed and would be a breaking change to be removed.
Examples
use tokio::signal::windows::ctrl_shutdown;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
// A listener of CTRL-SHUTDOWN events.
let mut signal = ctrl_shutdown()?;
// Print whenever a CTRL-SHUTDOWN event is received.
signal.recv().await;
println!("got CTRL-SHUTDOWN. Cleaning up before exiting");
Ok(())
}pub fn poll_recv(&mut self, cx: &mut Context<'_>) -> Poll<Option<()>>
Polls to receive the next signal notification event, outside of an async context.
Although this returns Option<()>, it will never actually return None. This was accidentally exposed and would be a breaking change to be removed.
Examples
Polling from a manually implemented future
use std::pin::Pin;
use std::future::Future;
use std::task::{Context, Poll};
use tokio::signal::windows::CtrlShutdown;
struct MyFuture {
ctrl_shutdown: CtrlShutdown,
}
impl Future for MyFuture {
type Output = Option<()>;
fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
println!("polling MyFuture");
self.ctrl_shutdown.poll_recv(cx)
}
}Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for CtrlShutdown
impl !UnwindSafe for CtrlShutdown
impl Freeze for CtrlShutdown
impl Send for CtrlShutdown
impl Sync for CtrlShutdown
impl Unpin for CtrlShutdown
impl UnsafeUnpin for CtrlShutdown
Blanket Implementations
impl<T> BorrowMut<T> for Twhere T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
impl<T> Instrument for T
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
impl<T> WithSubscriber for T
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
MIT License
Copyright © Tokio Contributors
https://docs.rs/tokio/1.53.1/tokio/signal/windows/struct.CtrlShutdown.html
