Struct Payload 

pub struct Payload { /* private fields */ }

Buffered HTTP/2 payload stream.

Use Payload::read to receive the next chunk asynchronously, or consume the payload through its Stream implementation. Waiting tasks are woken when data, end-of-stream, or an error becomes available.

This type is not thread-safe and can also be used as a Response body stream.

Implementations

impl Payload

pub fn create(cap: Capacity) -> (PayloadSender, Payload)

Create payload stream.

This method construct two objects responsible for bytes stream generation.

• PayloadSender - Sender side of the stream

• Payload - Receiver side of the stream

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

Receives the next payload chunk.

Returns None after the complete payload has been received.

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

Polls for the next payload chunk.

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

Returns the trailer fields received at the end of the payload.

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

Trait Implementations

impl Debug for Payload

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

Formats the value using the given formatter.

impl Drop for Payload

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

fn from(v: Payload) -> 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<Result<Bytes, PayloadError>>>

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.