Struct object_store::PutPayloadMut

pub struct PutPayloadMut { /* private fields */ }

A builder for PutPayload that avoids reallocating memory

Data is allocated in fixed blocks, which are flushed to Bytes once full. Unlike Vec this avoids needing to repeatedly reallocate blocks of memory, which typically involves copying all the previously written data to a new contiguous memory region.

Implementations

impl PutPayloadMut

pub fn new() -> Self

Create a new PutPayloadMut

pub fn with_block_size(self, block_size: usize) -> Self

Configures the minimum allocation size

Defaults to 8KB

pub fn extend_from_slice(&mut self, slice: &[u8])

Write bytes into this PutPayloadMut

If there is an in-progress block, data will be first written to it, flushing it to Bytes once full. If data remains to be written, a new block of memory of at least the configured block size will be allocated, to hold the remaining data.

pub fn push(&mut self, bytes: Bytes)

Append a Bytes to this PutPayloadMut without copying

This will close any currently buffered block populated by Self::extend_from_slice, and append bytes to this payload without copying.

pub fn is_empty(&self) -> bool

Returns true if this PutPayloadMut contains no bytes

pub fn content_length(&self) -> usize

Returns the total length of the Bytes in this payload

pub fn freeze(self) -> PutPayload

Convert into PutPayload

Trait Implementations

impl Debug for PutPayloadMut

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

Formats the value using the given formatter.

impl Default for PutPayloadMut

fn default() -> Self

Returns the “default value” for a type.

impl From<PutPayloadMut> for PutPayload

fn from(value: PutPayloadMut) -> Self

Converts to this type from the input type.