Struct stream_cancel::Valved

pub struct Valved<S>(/* private fields */);

A Valved is wrapper around a Stream that enables the stream to be turned off remotely to initiate a graceful shutdown. When a new Valved is created with Valved::new, a handle to that Valved is also produced; when [Trigger::close] is called on that handle, the wrapped stream will immediately yield None to indicate that it has completed.

Implementations

impl<S> Valved<S>

pub fn new(stream: S) -> (Trigger, Self)

where S: Stream,

Make the given stream cancellable.

To cancel the stream, call [Trigger::close] on the returned handle.

pub fn into_inner(self) -> S

Consumes this wrapper, returning the underlying stream.

Trait Implementations

impl<S: Clone> Clone for Valved<S>

fn clone(&self) -> Valved<S>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Debug> Debug for Valved<S>

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

Formats the value using the given formatter.

impl<S> Stream for Valved<S>

where S: Stream,

type Item = <S as Stream>::Item

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.