[][src]Struct futures_util::stream::Fuse

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

Stream for the fuse method.

Implementations

impl<St> Fuse<St>[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.

pub fn get_ref(&self) -> &St

Notable traits for &'_ mut F

impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized
type Output = <F as Future>::Output;
[src]

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

pub fn get_mut(&mut self) -> &mut St

Notable traits for &'_ mut F

impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized
type Output = <F as Future>::Output;
[src]

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

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

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut St>

Notable traits for Pin<P>

impl<P> Future for Pin<P> where
    P: Unpin + DerefMut,
    <P as Deref>::Target: Future
type Output = <<P as Deref>::Target as Future>::Output;
[src]

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

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

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

Consumes this combinator, returning the underlying sink or 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<St: Debug> Debug for Fuse<St>[src]

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

impl<St> PinnedDrop for Fuse<St>[src]

impl<S: Stream + Sink<Item>, Item> Sink<Item> for Fuse<S>[src]

type Error = S::Error

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

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

type Item = S::Item

Values yielded by the stream.

impl<'pin, St> Unpin for Fuse<St> where
    __Fuse<'pin, St>: Unpin
[src]

impl<St> UnsafeUnpin for Fuse<St>[src]

Auto Trait Implementations

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

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

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

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

Blanket Implementations

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

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

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

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

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

impl<T, Item> SinkExt<Item> for T where
    T: Sink<Item> + ?Sized
[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<S, T, E> TryStream for S where
    S: Stream<Item = Result<T, E>> + ?Sized
[src]

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future