Struct signal_hook_tokio::SignalsInfo

pub struct SignalsInfo<E: Exfiltrator = SignalOnly>(_);

An asynchronous Stream of arriving signals.

The stream doesn’t return the signals in the order they were recieved by the process and may merge signals received multiple times.

Implementations

impl<E: Exfiltrator> SignalsInfo<E>

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

Create a SignalsInfo instance.

This registers all the signals listed. The same restrictions (panics, errors) apply as with Handle::add_signal.

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

A constructor with explicit exfiltrator.

pub fn handle(&self) -> Handle

Get a shareable Handle for this Signals instance.

This can be used to add further signals or close the Signals instance which terminates the whole signal stream.

Trait Implementations

impl<E: Exfiltrator> Stream for SignalsInfo<E>

This is supported on crate feature futures-v0_3 only.

type Item = E::Output

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    ctx: &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.