Enum StreamingBody 

pub enum StreamingBody<B> {
    Buffered {
        data: Option<Bytes>,
    },
    Streaming {
        inner: B,
    },
    File {
        file: File,
        buf: Vec<u8>,
        finished: bool,
    },
}

Available on crate feature streaming only.

A body type that can represent either buffered data from cache, streaming body from upstream, or streaming from a file for file-based caching.

This enum allows the HTTP cache middleware to efficiently handle:

• Cached responses (buffered data)
• Cache misses (streaming from upstream)
• File-based cached responses (streaming from disk)

Variants

• Buffered: Contains cached response data that can be sent immediately
• Streaming: Wraps an upstream body for streaming responses
• File: Streams directly from a file for zero-copy caching

Example

use http_cache::StreamingBody;
use bytes::Bytes;
use http_body_util::Full;

// Cached response - sent immediately from memory
let cached: StreamingBody<Full<Bytes>> = StreamingBody::buffered(Bytes::from("Hello from cache!"));

// Streaming response - passed through from upstream
let upstream_body = MyBody;
let streaming = StreamingBody::streaming(upstream_body);

Variants

Buffered

Fields

data: Option<Bytes>

Streaming

Fields

inner: B

File

Fields

file: File

buf: Vec<u8>

finished: bool

Implementations

impl<B> StreamingBody<B>

pub fn buffered(data: Bytes) -> StreamingBody<B>

Create a new buffered body from bytes

pub fn streaming(body: B) -> StreamingBody<B>

Create a new streaming body from an upstream body

pub fn from_file(file: File) -> StreamingBody<B>

Create a new file-based streaming body

impl<B> StreamingBody<B>

where B: Body + Unpin + Send, <B as Body>::Error: Into<StreamingError>, <B as Body>::Data: Into<Bytes>,

pub fn into_bytes_stream( self, ) -> impl Stream<Item = Result<Bytes, Box<dyn Error + Send + Sync>>> + Send

Convert this streaming body into a stream of Bytes.

This method allows for streaming without collecting the entire body into memory first. This is particularly useful for file-based cached responses which can stream directly from disk.

Trait Implementations

impl<B> Body for StreamingBody<B>

where B: Body + Unpin, <B as Body>::Error: Into<StreamingError>, <B as Body>::Data: Into<Bytes>,

type Data = Bytes

Values yielded by the Body.

type Error = StreamingError

The error type this Body might generate.

fn poll_frame( self: Pin<&mut StreamingBody<B>>, cx: &mut Context<'_>, ) -> Poll<Option<Result<Frame<<StreamingBody<B> as Body>::Data>, <StreamingBody<B> as Body>::Error>>>

Attempt to pull out the next data buffer of this stream.

fn is_end_stream(&self) -> bool

Returns true when the end of stream has been reached.

fn size_hint(&self) -> SizeHint

Returns the bounds on the remaining length of the stream.

impl<B> From<Bytes> for StreamingBody<B>

fn from(bytes: Bytes) -> StreamingBody<B>

Converts to this type from the input type.

impl<'__pin, B> Unpin for StreamingBody<B>

where <PinnedFieldsOfHelperStruct<__Origin<'__pin, B>> as PinnedFieldsOfHelperTrait>::Actual: Unpin,