Struct WriteBuffer 

pub struct WriteBuffer<'a> { /* private fields */ }

Write buffer for compression-codecs.

Currently it only supports initialized buffer, but will support uninitialized buffer soon.

Layout

|                                       buffer                                    |
| written and initialized | unwritten but initialized | unwritten and uninitialized

Implementations

impl<'a> WriteBuffer<'a>

pub fn new_initialized(buffer: &'a mut [u8]) -> Self

pub fn new_uninitialized(buffer: &'a mut [MaybeUninit<u8>]) -> Self

pub fn capacity(&self) -> usize

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

pub fn initialized_len(&self) -> usize

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

pub fn written_len(&self) -> usize

Convenient method for .writen().len()

pub fn has_no_spare_space(&self) -> bool

Buffer has no spare space to write any data

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

Initialize all uninitialized, unwritten part to initialized, unwritten part Return all unwritten part

pub fn advance(&mut self, amount: usize)

Advance written index within initialized part.

Note that try to advance into uninitialized part would panic.

pub fn reset(&mut self)

pub unsafe fn unwritten_mut(&mut self) -> &mut [MaybeUninit<u8>]

Returns a mutable reference to the unwritten part of the buffer without ensuring that it has been fully initialized.

Safety

The caller must not de-initialize portions of the buffer that have already been initialized.

This includes any bytes in the region returned by this function.

pub unsafe fn assume_init(&mut self, n: usize)

Asserts that the first n unfilled bytes of the buffer are initialized.

WriteBuffer assumes that bytes are never de-initialized, so this method does nothing when called with fewer bytes than are already known to be initialized.

Safety

The caller must ensure that n unfilled bytes of the buffer have already been initialized.

pub unsafe fn assume_init_and_advance(&mut self, n: usize)

Convenient function combining WriteBuffer::assume_init and WriteBuffer::advance.

Safety

The caller must ensure that n unfilled bytes of the buffer have already been initialized.

pub unsafe fn set_written_and_initialized_len(&mut self, n: usize)

Convenient function combining WriteBuffer::assume_init and WriteBuffer::advance, works similar to Vec::set_len.

Safety

The caller must ensure that first n bytes of the buffer have already been initialized.

pub fn copy_unwritten_from<C: AsRef<[u8]>>( &mut self, other: &mut PartialBuffer<C>, ) -> usize

Trait Implementations

impl<'a> Debug for WriteBuffer<'a>

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

Formats the value using the given formatter.