Enum Buffer 

pub enum Buffer {
    Heap(BufferData),
    Shared(SharedBufferData),
    HeapView {
        data: BufferData,
        start: usize,
    },
    Pooled(ArenaBuffer),
}

Variants

Heap(BufferData)

Shared(SharedBufferData)

HeapView

A heap buffer with a logical start offset: only data[start..] is exposed via Buffer::as_slice / Buffer::len. Used to skip a pre-allocated prefix without shifting bytes in memory before I/O.

Fields

data: BufferData

start: usize

Pooled(ArenaBuffer)

Implementations

impl Buffer

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

pub fn new_shared(data: Arc<Box<[u8]>>) -> Self

pub fn new_shared_data(data: SharedBufferData) -> Self

pub fn new_with_start(data: Vec<u8>, start: usize) -> Self

Wraps data so that only bytes [start..] are visible via Buffer::as_slice / Buffer::len. The skipped prefix lives in memory but is never read by the I/O layer — useful when a caller has pre-allocated optional framing room at the front of a buffer and wants to elide it on a particular write without a memmove.

pub fn fixed_id(&self) -> Option<u32>

Returns the index of the underlying Arena if it was registered with io_uring. Only for use with UringIO backend.

pub fn new_pooled(buf: ArenaBuffer) -> Self

pub fn new_temporary(size: usize) -> Self

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

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

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

pub fn as_ptr(&self) -> *const u8

pub fn as_mut_ptr(&self) -> *mut u8

pub fn is_pooled(&self) -> bool

pub fn is_heap(&self) -> bool

Trait Implementations

impl Debug for Buffer

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

Formats the value using the given formatter.

impl Drop for Buffer

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.