Struct async_signals::Signals

pub struct Signals { /* fields omitted */ }

Handle unix signal like signal_hook::iterator::Signals, receive signals with futures::stream::Stream.

If you want to unregister all signal which register to a Signals, just drop it, it will unregister all signals.

Notes:

for now you can't re-register some signals after drops a Signals, it may change in the future.

Methods

impl Signals

pub fn new<I, S>(signals: I) -> Result<Self> where
    I: IntoIterator<Item = S>,
    S: Borrow<c_int>, 

Creates the Signals structure, all signals will be registered.

Examples

use async_signals::Signals;
use futures_util::StreamExt;
use nix::sys;
use nix::unistd;

#[async_std::main]
async fn main() {
    let mut signals = Signals::new(vec![libc::SIGINT]).unwrap();

    let pid = unistd::getpid();
    sys::signal::kill(pid, Some(sys::signal::SIGINT)).unwrap();

    let signal = signals.next().await.unwrap();
    let signal = signal.unwrap();

    assert_eq!(signal, libc::SIGINT);
}

pub fn add_signal(&self, signal: c_int) -> Result<()>

Registers another signal to a created Signals.

Examples

use async_signals::Signals;
use futures_util::StreamExt;
use nix::sys;
use nix::unistd;

#[async_std::main]
async fn main() {
    let mut signals = Signals::new(vec![libc::SIGHUP]).unwrap();

    signals.add_signal(libc::SIGINT).unwrap();

    let pid = unistd::getpid();
    sys::signal::kill(pid, Some(sys::signal::SIGINT)).unwrap();

    let signal = signals.next().await.unwrap();
    let signal = signal.unwrap();

    assert_eq!(signal, libc::SIGINT);
}

Trait Implementations

impl Drop for Signals

fn drop(&mut self)

Executes the destructor for this type.

impl Stream for Signals

type Item = Result<c_int>

Values yielded by the stream.

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.