Struct futures::sink::Buffer

#[must_use = "sinks do nothing unless polled"]
pub struct Buffer<S> where
    S: Sink,  { /* fields omitted */ }

Sink for the Sink::buffer combinator, which buffers up to some fixed number of values when the underlying sink is unable to accept them.

Methods

impl<S> Buffer<S> where
    S: Sink, 

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

Get a shared reference to the inner sink.

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

Get a mutable reference to the inner sink.

pub fn into_inner(self) -> S

Consumes this combinator, returning the underlying sink.

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 for Buffer<S> where
    S: Debug + Sink,
    <S as Sink>::SinkItem: Debug, 

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

Formats the value using the given formatter.

impl<S> Sink for Buffer<S> where
    S: Sink, 

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<()>, <Buffer<S> as Sink>::SinkError>

Attempts to prepare the Sink to receive a value.

fn start_send(
    &mut self,
    item: <Buffer<S> as Sink>::SinkItem
) -> Result<(), <Buffer<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<()>, <Buffer<S> as Sink>::SinkError>

Flush any remaining output from this sink.

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

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

impl<S> Stream for Buffer<S> where
    S: Sink + Stream, 

type Item = <S as Stream>::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<<S as Stream>::Item>>, <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.