Enum DocPayload 

pub enum DocPayload<'a> {
    Borrowed(&'a [u8]),
    Mapped(MmapView<'a>),
    Owned(Bytes),
    Stream(ByteStream<'a>),
}

The body of a fetched document, in whichever representation avoids a copy.

Variants

Borrowed(&'a [u8])

Borrowed directly from the caller’s buffer — zero copy.

Mapped(MmapView<'a>)

A memory-mapped view (e.g. a local file) — zero copy.

Owned(Bytes)

An owned, reference-counted buffer (e.g. a network fetch).

Stream(ByteStream<'a>)

A lazily-produced byte stream for large bodies.

Implementations

impl DocPayload<'_>

pub fn as_slice(&self) -> Option<&[u8]>

Borrow the bytes if they are already materialized in memory.

Returns None for DocPayload::Stream, which must be consumed via DocPayload::into_bytes.

pub fn len(&self) -> Option<usize>

The byte length if known without consuming a stream.

pub fn is_empty(&self) -> Option<bool>

Whether an in-memory payload is empty (always None for streams).

pub async fn into_bytes(self) -> Result<Bytes>

Collect the payload into a contiguous Bytes, draining a stream if needed.

Trait Implementations

impl Debug for DocPayload<'_>

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

Formats the value using the given formatter.