[][src]Struct futures::stream::Flatten

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

A combinator used to flatten a stream-of-streams into one long stream of elements.

This combinator is created by the Stream::flatten method.

Methods

impl<S: Stream> Flatten<S>[src]

pub fn get_ref(&self) -> &S[src]

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

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: Debug> Debug for Flatten<S> where
    S: Stream,
    S::Item: Debug
[src]

impl<S> Sink for Flatten<S> where
    S: Sink + Stream
[src]

type SinkItem = S::SinkItem

The type of value that the sink accepts.

type SinkError = S::SinkError

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

impl<S> Stream for Flatten<S> where
    S: Stream,
    S::Item: Stream,
    <S::Item as Stream>::Error: From<S::Error>, 
[src]

type Item = <S::Item as Stream>::Item

The type of item this stream will yield on success.

type Error = <S::Item as Stream>::Error

The type of error this stream may generate.

Auto Trait Implementations

impl<S> RefUnwindSafe for Flatten<S> where
    S: RefUnwindSafe,
    <S as Stream>::Item: RefUnwindSafe

impl<S> Send for Flatten<S> where
    S: Send,
    <S as Stream>::Item: Send

impl<S> Sync for Flatten<S> where
    S: Sync,
    <S as Stream>::Item: Sync

impl<S> Unpin for Flatten<S> where
    S: Unpin,
    <S as Stream>::Item: Unpin

impl<S> UnwindSafe for Flatten<S> where
    S: UnwindSafe,
    <S as Stream>::Item: 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, 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.