Struct AlignedBuf 

pub struct AlignedBuf { /* private fields */ }

An aligned byte buffer suitable for O_DIRECT I/O.

The buffer’s starting address is guaranteed to be aligned to alignment, and its capacity is rounded up to a multiple of alignment.

Implementations

impl AlignedBuf

pub fn new(min_capacity: usize, alignment: usize) -> Result<Self>

Allocate a new aligned buffer.

min_capacity is rounded up to the next multiple of alignment. alignment must be a power of two.

pub fn with_default_alignment(min_capacity: usize) -> Result<Self>

Allocate with the default 4 KiB alignment.

pub fn write(&mut self, data: &[u8]) -> usize

Write bytes into the buffer. Returns the number of bytes written.

If the buffer doesn’t have enough remaining capacity, writes as much as possible and returns the count.

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

Get the written portion of the buffer as a byte slice.

The returned slice starts at an aligned address.

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

Get the written portion padded up to the next alignment boundary.

O_DIRECT requires the I/O size to be a multiple of the block size. The padding bytes are zeroed (from alloc_zeroed).

pub fn clear(&mut self)

Reset the buffer for reuse without deallocating.

pub fn len(&self) -> usize

Current number of bytes written.

pub fn is_empty(&self) -> bool

Whether the buffer has no written data.

pub fn capacity(&self) -> usize

Total capacity of the buffer.

pub fn remaining(&self) -> usize

Remaining capacity.

pub fn alignment(&self) -> usize

The alignment of this buffer.

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

Raw pointer to the buffer start (for io_uring submission).

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

Mutable raw pointer to the buffer start.

Trait Implementations

impl Drop for AlignedBuf

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.

impl Send for AlignedBuf