Struct actix_http::h1::Payload

pub struct Payload { /* fields omitted */ }

Buffered stream of bytes chunks

Payload stores chunks in a vector. First chunk can be received with .readany() method. Payload stream is not thread safe. Payload does not notify current task when new data is available.

Payload stream can be used as Response body stream.

Implementations

impl Payload

pub fn create(eof: bool) -> (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 fn unread_data(&mut self, data: Bytes)

Put unused data back to payload

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

Trait Implementations

impl Debug for Payload

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

Formats the value using the given formatter.

impl<S> From<Payload> for Payload<S>

fn from(v: Payload) -> Self

Performs the conversion.

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.