[][src]Struct tokio::prelude::stream::Fuse

#[must_use = "streams do nothing unless polled"]
pub struct Fuse<S> { /* fields omitted */ }

A stream which "fuse"s a stream once it's terminated.

Normally streams can behave unpredictably when used after they have already finished, but Fuse continues to return None from poll forever when finished.

Methods

impl<S> Fuse<S>[src]

pub fn is_done(&self) -> bool[src]

Returns whether the underlying stream has finished or not.

If this method returns true, then all future calls to poll are guaranteed to return None. If this returns false, then the underlying stream is still in use.

Important traits for &'_ mut W
pub fn get_ref(&self) -> &S[src]

Acquires a reference to the underlying stream that this combinator is pulling from.

Important traits for &'_ mut W
pub fn get_mut(&mut self) -> &mut S[src]

Acquires a mutable reference to the underlying stream that this combinator is pulling from.

Note that care must be taken to avoid tampering with the state of the stream which may otherwise confuse this combinator.

pub fn into_inner(self) -> S[src]

Consumes this combinator, returning the underlying stream.

Note that this may discard intermediate state of this combinator, so care should be taken to avoid losing resources when this is called.

Trait Implementations

impl<S> Stream for Fuse<S> where
    S: Stream
[src]

type Item = <S as Stream>::Item

The type of item this stream will yield on success.

type Error = <S as Stream>::Error

The type of error this stream may generate.

impl<S> Sink for Fuse<S> where
    S: Sink
[src]

type SinkItem = <S as Sink>::SinkItem

The type of value that the sink accepts.

type SinkError = <S as Sink>::SinkError

The type of value produced by the sink when an error occurs.

impl<S> Debug for Fuse<S> where
    S: Debug
[src]

Auto Trait Implementations

impl<S> Send for Fuse<S> where
    S: Send

impl<S> Unpin for Fuse<S> where
    S: Unpin

impl<S> Sync for Fuse<S> where
    S: Sync

impl<S> UnwindSafe for Fuse<S> where
    S: UnwindSafe

impl<S> RefUnwindSafe for Fuse<S> where
    S: RefUnwindSafe

Blanket Implementations

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

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

The type returned in the event of a conversion error.

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

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

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