Struct StagingBuffer 

pub struct StagingBuffer<'arena, 'b> { /* private fields */ }

A staging buffer over the remaining bytes of a PrefixArena.

StagingBuffer lets callers append bytes into temporary arena-backed storage, inspect the written prefix, and finally detach that written prefix from the underlying arena.

Implementations

impl<'arena, 'b> StagingBuffer<'arena, 'b>

where 'b: 'arena,

pub const fn new(arena: &'arena mut PrefixArena<'b>) -> Self

Creates a staging buffer over the remaining space of the given arena.

pub fn push_byte(&mut self, byte: u8) -> Result<(), StagingBufferError>

Appends one byte to the written prefix.

Returns Ok(()) on success and Err(()) if no capacity remains.

pub fn extend_from_slice( &mut self, slice: &[u8], ) -> Result<(), StagingBufferError>

Appends the entire slice to the written prefix.

Returns Ok(()) on success and Err(()) if the full slice does not fit.

pub fn extend_from_slice_capped(&mut self, slice: &[u8]) -> usize

Appends as much of the slice as fits and returns the number of bytes written.

pub fn written(&self) -> &[u8]

Returns the written prefix as an immutable slice.

pub fn written_mut(&mut self) -> &mut [u8]

Returns the written prefix as a mutable slice.

pub const fn len(&self) -> usize

Returns the number of bytes currently stored in the buffer.

pub const fn is_empty(&self) -> bool

Returns true when no bytes have been written.

pub const fn capacity(&self) -> usize

Returns the total capacity of the buffer.

pub const fn spare_capacity(&self) -> usize

Returns how many bytes can still be appended without overflowing.

pub fn clear(&mut self)

Marks the buffer as empty without modifying the underlying bytes.

pub fn into_written_slice(self) -> &'b mut [u8]

Detaches the written prefix from the underlying arena.