[−][src]Struct stream_cancel::Valved
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>
[src]
pub fn new(stream: S) -> (Trigger, Self) where
S: Stream,
[src]
S: Stream,
Make the given stream cancellable.
To cancel the stream, call [Trigger::close
] on the returned handle.
Trait Implementations
impl<S: Clone> Clone for Valved<S>
[src]
impl<S: Debug> Debug for Valved<S>
[src]
impl<S> Stream for Valved<S> where
S: Stream,
[src]
S: Stream,
Auto Trait Implementations
impl<S> !RefUnwindSafe for Valved<S>
[src]
impl<S> Send for Valved<S> where
S: Send,
[src]
S: Send,
impl<S> !Sync for Valved<S>
[src]
impl<S> Unpin for Valved<S> where
S: Unpin,
[src]
S: Unpin,
impl<S> !UnwindSafe for Valved<S>
[src]
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,
pub 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.
pub fn to_owned(&self) -> T
[src]
pub 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.
pub 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>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<S, T, E> TryStream for S where
S: Stream<Item = Result<T, E>> + ?Sized,
[src]
S: Stream<Item = Result<T, E>> + ?Sized,