[][src]Struct futures::stream::Buffered

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

An adaptor for a stream of futures to execute the futures concurrently, if possible.

This adaptor will buffer up a list of pending futures, and then return their results in the order that they were pulled out of the original stream. This is created by the Stream::buffered method.

Methods

impl<S> Buffered<S> where
    S: Stream,
    S::Item: IntoFuture<Error = <S as Stream>::Error>, 
[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> Stream for Buffered<S> where
    S: Stream,
    S::Item: IntoFuture<Error = <S as Stream>::Error>, 
[src]

type Item = <S::Item as IntoFuture>::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 Buffered<S> where
    S: Sink + Stream,
    S::Item: IntoFuture
[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> Debug for Buffered<S> where
    S: Stream + Debug,
    S::Item: IntoFuture,
    <<S as Stream>::Item as IntoFuture>::Future: Debug,
    <<S as Stream>::Item as IntoFuture>::Item: Debug,
    <<S as Stream>::Item as IntoFuture>::Error: Debug
[src]

Auto Trait Implementations

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

impl<S> Send for Buffered<S> where
    S: Send,
    <<S as Stream>::Item as IntoFuture>::Future: Send,
    <<S as Stream>::Item as IntoFuture>::Item: Send

impl<S> Sync for Buffered<S> where
    S: Sync,
    <<S as Stream>::Item as IntoFuture>::Future: Sync,
    <<S as Stream>::Item as IntoFuture>::Item: Sync

impl<S> !UnwindSafe for Buffered<S>

impl<S> !RefUnwindSafe for Buffered<S>

Blanket Implementations

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> Into<U> for T where
    U: From<T>, 
[src]

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> Borrow<T> for T where
    T: ?Sized
[src]

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

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