Struct tokio::signal::windows::CtrlBreak

#[must_use = "streams do nothing unless polled"]pub struct CtrlBreak { /* fields omitted */ }

This is supported on crate feature signal only.

Represents a stream which receives "ctrl-break" notifications sent to the process via SetConsoleCtrlHandler.

A notification to this process notifies all streams 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 stream may only receive one item about the two notifications.

Implementations

impl CtrlBreak

pub async fn recv(&mut self) -> Option<()>

Receives the next signal notification event.

None is returned if no more events can be received by this stream.

Examples

use tokio::signal::windows::ctrl_break;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // An infinite stream of CTRL-BREAK events.
    let mut stream = ctrl_break()?;

    // Print whenever a CTRL-BREAK event is received.
    loop {
        stream.recv().await;
        println!("got signal CTRL-BREAK");
    }
}

pub fn poll_recv(&mut self, cx: &mut Context<'_>) -> Poll<Option<()>>

Polls to receive the next signal notification event, outside of an async context.

None is returned if no more events can be received by this stream.

Examples

Polling from a manually implemented future

use std::pin::Pin;
use std::future::Future;
use std::task::{Context, Poll};
use tokio::signal::windows::CtrlBreak;

struct MyFuture {
    ctrl_break: CtrlBreak,
}

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_break.poll_recv(cx)
    }
}

Trait Implementations

impl Debug for CtrlBreak

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.