Struct stream_cancel::Valve

pub struct Valve(_);

A Valve is associated with a Trigger, and can be used to wrap one or more asynchronous streams. All streams wrapped by a given Valve (or its clones) will be interrupted when [Trigger::close] is called on the valve’s associated handle.

Implementations

impl Valve

pub fn new() -> (Trigger, Self)

Make a new Valve and an associated Trigger.

pub fn wrap<S>(&self, stream: S) -> Valved<S>where
    S: Stream,

Wrap the given stream with this Valve.

When [Trigger::close] is called on the handle associated with this valve, the given stream will immediately yield None.

Trait Implementations

impl Clone for Valve

fn clone(&self) -> Valve

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Valve

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

Formats the value using the given formatter.