Struct signal_hook::iterator::backend::SignalIterator

pub struct SignalIterator<R, E: Exfiltrator> { /* fields omitted */ }

An infinite iterator of received signals.

Implementations

impl<R, E: Exfiltrator> SignalIterator<R, E> where
    R: 'static + AsRawFd + Send + Sync, 

pub fn new(signals: SignalDelivery<R, E>) -> Self

Create a new infinite iterator for signals registered with the passed in SignalDelivery instance.

pub fn poll_signal<F>(&mut self, has_signals: &mut F) -> PollResult<E::Output> where
    F: FnMut(&mut R) -> Result<bool, Error>, 

Return a signal if there is one or tell the caller that there is none at the moment.

You have to pass in a callback which checks the underlying reading end of the pipe if there may be any pending signals. This callback may or may not block. If the callback returns true this method will try to fetch the next signal and return it as a PollResult::Signal. If the callback returns false the method will return PollResult::Pending and assume it will be called again at a later point in time. The callback may be called any number of times by this function.

If the iterator was closed by the close method of the associtated Handle this method will return PollResult::Closed.

pub fn handle(&self) -> Handle

Get a shareable Handle for this instance.

This can be used to add further signals or terminate the whole signal iteration using the close method.

pub fn into_inner(self) -> SignalDelivery<R, E>

Consume this iterator and return the inner SignalDelivery instance.