[−][src]Struct stream_cancel::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]
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.
pub fn poll_closed(self: Pin<&mut Self>, cx: &mut Context) -> Poll<bool>[src]
Check if the valve has been closed.
If Ready, contains true if the stream should be considered closed, and false
if the Trigger has been disabled.
Trait Implementations
impl Clone for Valve[src]
impl Debug for Valve[src]
impl PinnedDrop for Valve[src]
impl<'pin> Unpin for Valve where
__Valve<'pin>: Unpin, [src]
__Valve<'pin>: Unpin,
Auto Trait Implementations
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T[src]
impl<T> From<T> for T[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone, [src]
T: Clone,
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> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
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]
U: TryFrom<T>,