Enum Payload 

pub enum Payload {
    None,
    H1(Payload),
    H2(Payload),
    Stream(PayloadStream),
}

An HTTP request payload.

Variants

None

No payload is available.

H1(Payload)

An HTTP/1 payload stream.

H2(Payload)

An HTTP/2 payload stream.

Stream(PayloadStream)

A custom payload stream.

Implementations

impl Payload

pub fn take(&mut self) -> Self

Takes the payload and replaces it with Payload::None.

pub fn from_stream<S>(stream: S) -> Self

where S: Stream<Item = Result<Bytes, PayloadError>> + 'static,

Creates a payload from a local asynchronous byte stream.

The stream is pinned and does not need to implement Unpin. It must yield HTTP PayloadError values directly.

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

Waits for and returns the next payload chunk.

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

Polls for the next payload chunk.

Registers the current task for wakeup when data is not yet available and returns Poll::Ready(None) after the payload is exhausted.

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. HTTP/1 chunked and HTTP/2 payloads provide trailers.

Trait Implementations

impl Debug for Payload

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

Formats the value using the given formatter.

impl Default for Payload

fn default() -> Payload

Returns the “default value” for a type.

impl From<Payload> for Payload

fn from(v: Payload) -> Self

Converts to this type from the input type.

impl From<Payload> for Payload

fn from(v: Payload) -> Self

Converts to this type from the input type.

impl From<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>>>>> for Payload

fn from(pl: PayloadStream) -> Self

Converts to this type from the input type.

impl From<Receiver<PayloadError>> for Payload

fn from(v: 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.