Struct Receiver 

pub struct Receiver<E> { /* private fields */ }

A buffered stream of byte chunks.

The receiver yields chunks in insertion order. Its configured buffer size is a cooperative backpressure threshold for the sender, not a hard memory limit.

Implementations

impl<E> Receiver<E>

pub fn set_watermarks(&self, high: u32, low: u32)

Sets the sender backpressure watermarks.

Once buffered data reaches high bytes, Sender::poll_ready stops reporting Status::Ready until the receiver drains the buffer to low bytes or less, so the sender is not woken for every consumed chunk. low is capped below high.

Sending does not enforce the watermarks, so producers must cooperate by waiting for readiness. Changing the watermarks immediately updates and, when needed, wakes sender readiness: the sender is ready if buffered data is below high. The defaults are 32 KiB and 16 KiB.

pub fn max_buffer_size(&self, size: usize)

👎Deprecated since 4.2.0:

Use Receiver::set_watermarks() instead

Sets the sender backpressure threshold.

Sets the high watermark to size and the low watermark to half of it.

pub fn put(&self, data: Bytes)

Puts previously read data back at the front of the stream.

This may grow the buffer past its readiness threshold.

pub fn is_eof(&self) -> bool

Returns true once EOF has been marked.

Buffered chunks may still be available after this returns true.

pub async fn read(&self) -> Option<Result<Bytes, E>>

Waits for and returns the next chunk, stream error, or EOF.

pub fn poll_read(&self, cx: &mut Context<'_>) -> Poll<Option<Result<Bytes, E>>>

Polls for the next chunk, stream error, or EOF.

Trait Implementations

impl<E> Debug for Receiver<E>

where E: Debug,

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

Formats the value using the given formatter.

impl<E> Drop for Receiver<E>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl From<Receiver<PayloadError>> for Payload

fn from(v: Receiver<PayloadError>) -> Self

Converts to this type from the input type.

impl From<Receiver<PayloadError>> for Payload

fn from(rx: Receiver<PayloadError>) -> Self

Converts to this type from the input type.

impl<E> Stream for Receiver<E>

type Item = Result<Bytes, E>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Receiver<E>>, cx: &mut Context<'_>, ) -> Poll<Option<<Receiver<E> as Stream>::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.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.