Struct futures::stream::Buffered

#[must_use = "streams do nothing unless polled"]
pub struct Buffered<S> where
    S: Stream,
    <S as Stream>::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 as Stream>::Item: IntoFuture,
    <<S as Stream>::Item as IntoFuture>::Error == <S as Stream>::Error, 

Important traits for &'a mut I

impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, 

pub fn get_ref(&self) -> &S

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

Important traits for &'a mut I

impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, 

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

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

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> Sink for Buffered<S> where
    S: Sink + Stream,
    <S as Stream>::Item: IntoFuture, 

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.

fn poll_ready(
    &mut self,
    cx: &mut Context
) -> Result<Async<()>, <Buffered<S> as Sink>::SinkError>

Attempts to prepare the Sink to receive a value.

fn start_send(
    &mut self,
    item: <Buffered<S> as Sink>::SinkItem
) -> Result<(), <Buffered<S> as Sink>::SinkError>

Begin the process of sending a value to the sink. Each call to this function must be proceeded by a successful call to poll_ready which returned Ok(Async::Ready(())).

fn poll_flush(
    &mut self,
    cx: &mut Context
) -> Result<Async<()>, <Buffered<S> as Sink>::SinkError>

Flush any remaining output from this sink.

fn poll_close(
    &mut self,
    cx: &mut Context
) -> Result<Async<()>, <Buffered<S> as Sink>::SinkError>

Flush any remaining output and close this sink, if necessary.

impl<S> Debug for Buffered<S> where
    S: Stream + Debug,
    <S as Stream>::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, 

fn fmt(&self, fmt: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

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

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

Values yielded by the stream.

type Error = <S as Stream>::Error

Errors yielded by the stream.

fn poll_next(
    &mut self,
    cx: &mut Context
) -> Result<Async<Option<<Buffered<S> as Stream>::Item>>, <Buffered<S> as Stream>::Error>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.