Struct async_signals::Signals

pub struct Signals { /* fields omitted */ }

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

If multi Signals register a same signal, all of them will receive the signal.

If you drop all Signals which handle a signal like SIGINT, when process receive this signal, will use system default handler.

Notes:

You can't handle SIGKILL or SIGSTOP.

Methods

impl Signals

pub fn new<I: IntoIterator<Item = c_int>>(signals: I) -> Result<Signals>

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();

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

pub fn add_signal(&mut 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();

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

Trait Implementations

impl Debug for Signals

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

Formats the value using the given formatter.

impl Drop for Signals

fn drop(&mut self)

Executes the destructor for this type.

impl Stream for Signals

type Item = 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.