signal_hook_tokio

Struct SignalsInfo

Source
pub struct SignalsInfo<E: Exfiltrator = SignalOnly>(/* private fields */);
Expand description

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§

Source§

impl<E: Exfiltrator> SignalsInfo<E>

Source

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.

Source

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.

Source

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§

Source§

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

Available on crate feature futures-v0_3 only.
Source§

type Item = <E as Exfiltrator>::Output

Values yielded by the stream.
Source§

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. Read more
Source§

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

Returns the bounds on the remaining length of the stream. Read more

Auto Trait Implementations§

§

impl<E = SignalOnly> !Freeze for SignalsInfo<E>

§

impl<E = SignalOnly> !RefUnwindSafe for SignalsInfo<E>

§

impl<E> Send for SignalsInfo<E>

§

impl<E> Sync for SignalsInfo<E>

§

impl<E> Unpin for SignalsInfo<E>

§

impl<E = SignalOnly> !UnwindSafe for SignalsInfo<E>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T, E> TryStream for S
where S: Stream<Item = Result<T, E>> + ?Sized,

Source§

type Ok = T

The type of successful values yielded by this future
Source§

type Error = E

The type of failures yielded by this future
Source§

fn try_poll_next( self: Pin<&mut S>, cx: &mut Context<'_>, ) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>

Poll this TryStream as if it were a Stream. Read more