Struct tokio_stream::wrappers::SignalStream

pub struct SignalStream { /* private fields */ }

Available on Unix and crate feature signal only.

A wrapper around Signal that implements Stream.

Implementations

impl SignalStream

pub fn new(interval: Signal) -> Self

Create a new SignalStream.

pub fn into_inner(self) -> Signal

Get back the inner Signal.

Trait Implementations

impl AsMut<Signal> for SignalStream

fn as_mut(&mut self) -> &mut Signal

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<Signal> for SignalStream

fn as_ref(&self) -> &Signal

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for SignalStream

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

Formats the value using the given formatter.

impl Stream for SignalStream

type Item = ()

Values yielded by the stream.

fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<()>>

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.