Struct async_signal::Signals

pub struct Signals { /* private fields */ }

Wait for a specific set of signals.

See the module-level documentation for more details.

Implementations

impl Signals

pub fn new<B>(signals: impl IntoIterator<Item = B>) -> Result<Self>

where B: Borrow<Signal>,

Create a new Signals instance with a set of signals.

pub fn add_signals<B>( &mut self, signals: impl IntoIterator<Item = B>, ) -> Result<()>

where B: Borrow<Signal>,

Add signals to the set of signals to wait for.

One signal cannot be added twice. If a signal that has already been added is passed to this method, it will be ignored.

Registering a signal prevents the default behavior of that signal from occurring. For example, if you register SIGINT, pressing Ctrl+C will no longer terminate the process. To run the default signal handler, use signal_hook::low_level::emulate_default_handler instead.

pub fn remove_signals<B>( &mut self, signals: impl IntoIterator<Item = B>, ) -> Result<()>

where B: Borrow<Signal>,

Remove signals from the set of signals to wait for.

This function can be used to opt out of listening to signals previously registered via add_signals or new. If a signal that has not been registered is passed to this method, it will be ignored.

Trait Implementations

impl AsFd for Signals

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for Signals

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

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 = Result<Signal, Error>

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.

impl Stream for Signals

type Item = Result<Signal, Error>

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.

impl Unpin for Signals