[−][src]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.

Methods

`impl Valve`[src]

`pub fn new() -> (Trigger, Self)`[src]

Make a new Valve and an associated Trigger.

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

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`[src]

`fn clone(&self) -> Valve`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Debug for Valve`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

Auto Trait Implementations

`impl Send for Valve`

`impl Unpin for Valve`

`impl Sync for Valve`

`impl !UnwindSafe for Valve`

`impl !RefUnwindSafe for Valve`

Blanket Implementations

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, >::Error>`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

[−][src]Struct stream_cancel::Valve

Methods

`impl Valve`[src]

`pub fn new() -> (Trigger, Self)`[src]

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

Trait Implementations

`impl Clone for Valve`[src]

`fn clone(&self) -> Valve`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Debug for Valve`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

Auto Trait Implementations

`impl Send for Valve`

`impl Unpin for Valve`

`impl Sync for Valve`

`impl !UnwindSafe for Valve`

`impl !RefUnwindSafe for Valve`

Blanket Implementations

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

`type Error = <U as TryFrom<T>>::Error`

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

[−][src]Struct stream_cancel::Valve

Methods

impl Valve[src]

pub fn new() -> (Trigger, Self)[src]

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

Trait Implementations

impl Clone for Valve[src]

fn clone(&self) -> Valve[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Debug for Valve[src]

fn fmt(&self, f: &mut Formatter) -> Result[src]

Auto Trait Implementations

impl Send for Valve

impl Unpin for Valve

impl Sync for Valve

impl !UnwindSafe for Valve

impl !RefUnwindSafe for Valve

Blanket Implementations

impl<T> ToOwned for T where T: Clone, [src]

type Owned = T

fn to_owned(&self) -> T[src]

fn clone_into(&self, target: &mut T)[src]

impl<T, U> Into<U> for T where U: From<T>, [src]

fn into(self) -> U[src]

impl<T> From<T> for T[src]

fn from(t: T) -> T[src]

impl<T, U> TryFrom<U> for T where U: Into<T>, [src]

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

impl<T, U> TryInto<U> for T where U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

fn borrow_mut(&mut self) -> &mut T[src]

impl<T> Borrow<T> for T where T: ?Sized, [src]

fn borrow(&self) -> &T[src]

impl<T> Any for T where T: 'static + ?Sized, [src]

fn type_id(&self) -> TypeId[src]

`impl Valve`[src]

`pub fn new() -> (Trigger, Self)`[src]

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

`impl Clone for Valve`[src]

`fn clone(&self) -> Valve`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Debug for Valve`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl Send for Valve`

`impl Unpin for Valve`

`impl Sync for Valve`

`impl !UnwindSafe for Valve`

`impl !RefUnwindSafe for Valve`

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

`type Error = <U as TryFrom<T>>::Error`

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]