Struct Payload 

pub struct Payload { /* private fields */ }

A buffered stream of an HTTP/1 request body’s decoded bytes.

Each item is either a body chunk or a PayloadError. Normal body completion closes the stream, after which receiving returns None. A payload error is yielded once before the stream terminates.

The HTTP/1 dispatcher stops reading body data while this stream’s buffer is full. Consuming items therefore releases transport-level backpressure. Dropping the stream before the complete body has been decoded prevents the connection from being reused and causes the dispatcher to disconnect it.

Dereferences to the underlying bstream::Receiver.

Implementations

impl Payload

pub fn trailers(&self) -> Option<HeaderMap>

Returns the trailer fields of a chunked payload.

Trailers are available once the payload is complete, None is returned if the payload is not complete or has no trailers.

Methods from Deref<Target = Receiver<PayloadError>>

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 Debug for Payload

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

Formats the value using the given formatter.

impl Deref for Payload

type Target = Receiver<PayloadError>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<Payload> for Payload

fn from(v: Payload) -> 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 Stream for Payload

type Item = Result<Bytes, PayloadError>

Values yielded by the stream.

fn poll_next( self: Pin<&mut 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.

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

Returns the bounds on the remaining length of the stream.