Struct Buffer 

pub struct Buffer<State> { /* private fields */ }

A buffer with type-state tracking ownership.

Implementations

impl<State> Buffer<State>

pub fn capacity(&self) -> usize

Returns the total capacity.

pub fn filled_len(&self) -> usize

Returns the number of initialized bytes.

impl Buffer<Owned>

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

Returns the full immutable slice.

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

Returns the full mutable slice for writing.

pub fn set_filled_len(self, len: usize) -> Result<Self>

Marks bytes as initialized.

pub fn into_submitted(self) -> Buffer<Submitted>

Transitions the buffer into submitted state.

impl Buffer<Submitted>

pub fn from_vec(data: Vec<u8>) -> Result<Self>

Creates a submitted buffer from caller-owned memory.

This bypasses the buffer pool entirely, useful for operations like Write where the user provides an arbitrary vector.

pub fn into_completed(self, filled: usize) -> Result<Buffer<Completed>>

Transitions the buffer into completed state.

impl Buffer<Pool>

pub fn into_completed(self, filled: usize) -> Result<Buffer<Completed>>

Transitions the buffer into completed state.

impl Buffer<Completed>

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

Returns the slice of initialized data.

pub fn truncate(self, len: usize) -> Result<Self>

Truncates the filled portion to len bytes.

pub fn release(self) -> Buffer<Owned>

Releases the buffer back to the user code explicitly resetting the filled length.

Trait Implementations

impl<State: Debug> Debug for Buffer<State>

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

Formats the value using the given formatter.

impl<State> Drop for Buffer<State>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.