Struct futures_util::stream::Buffered

[+] Show declaration

[+] Expand attributes
#[must_use = "streams do nothing unless polled"]
pub struct Buffered<St: Stream> where
    St: Stream,
    St::Item: Future,  { /* fields omitted */ }

[−] Expand description

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<St> Buffered<St> where     St: Stream,     St::Item: Future,

[−]

Important traits for &'a mut W

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

pub fn get_ref(&self) -> &St

[−]

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

Important traits for &'a mut W

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

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

[−]

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 get_pin_mut<'a>(self: PinMut<'a, Self>) -> PinMut<'a, St>

[−]

Acquires a mutable pinned 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) -> St

[−]

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<St> Unpin for Buffered<St> where     St: Stream + Unpin,     St::Item: Future,

impl<St> Debug for Buffered<St> where     St: Stream + Debug,     St::Item: Future,

[+]

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

[−]

Formats the value using the given formatter.

impl<St> Stream for Buffered<St> where     St: Stream,     St::Item: Future,

[+]

type Item = <St::Item as Future>::Output

Values yielded by the stream.

fn poll_next(self: PinMut<Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

[−]

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.

impl<S> Sink for Buffered<S> where     S: Stream + Sink,     S::Item: Future,

[+]

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.

fn poll_ready(     self: PinMut<Self>,     cx: &mut Context ) -> Poll<Result<(), Self::SinkError>>

[−]

Attempts to prepare the Sink to receive a value.

fn start_send(     self: PinMut<Self>,     item: Self::SinkItem ) -> Result<(), Self::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(Poll::Ready(())).

fn poll_flush(     self: PinMut<Self>,     cx: &mut Context ) -> Poll<Result<(), Self::SinkError>>

[−]

Flush any remaining output from this sink.

fn poll_close(     self: PinMut<Self>,     cx: &mut Context ) -> Poll<Result<(), Self::SinkError>>

[−]

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