Struct StreamingBody 

pub struct StreamingBody { /* private fields */ }

Typed streaming HTTP response body.

exact_length is optional. HTTP/1 uses chunked transfer coding when it is absent, while HTTP/2 emits DATA frames without a content-length field.

Implementations

impl StreamingBody

pub fn new(stream: impl BodyStream) -> Self

pub fn from_chunks<I, Chunk>(chunks: I) -> Self

where I: IntoIterator<Item = Chunk>, I::IntoIter: Unpin + 'static, Chunk: Into<Vec<u8>> + 'static,

Builds a pull stream from already available chunks.

pub fn once(bytes: impl Into<Vec<u8>>) -> Self

Builds a one-chunk stream with a known exact length.

pub const fn with_exact_length(self, length: u64) -> Self

pub const fn exact_length(&self) -> Option<u64>

pub async fn next_chunk(&mut self) -> Option<Result<Vec<u8>, BodyStreamError>>

Waits until the producer yields one chunk.

Calling this method is the consumer demand signal. Transports should not request another chunk until the previous one has been written.

pub fn recycle(&mut self, spent: Vec<u8>)

Hands a spent chunk’s buffer back to the producer for reuse.

See BodyStream::recycle; producers that do not reuse buffers simply drop it.

Trait Implementations

impl ApiSchema for StreamingBody

fn type_descriptor() -> TypeDescriptor

fn validate_input(&self) -> Result<(), ValidationErrors>

Validates a decoded operation argument.

impl Debug for StreamingBody

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

Formats the value using the given formatter.