Struct BufferRef

pub struct BufferRef<'buffer, T> { /* private fields */ }

A reference to a Buffer, which is meant be a subset of the functionality offered by the fully owned buffer.

For example, it neither allows reading from the unfilled region, nor swapping out the buffer pointed to, with anything else.

Implementations

impl<'buffer, T> BufferRef<'buffer, T>

pub fn items_filled(&self) -> usize

pub fn by_ref(&mut self) -> BufferRef<'_, T>

Reborrow the inner buffer, getting a buffer reference with a shorter lifetime.

impl<'buffer, T> BufferRef<'buffer, T>

where T: Initialize,

pub fn remaining(&self) -> usize

pub fn unfilled_parts( &mut self, ) -> (&mut [T::Item], &mut [MaybeUninit<T::Item>])

pub unsafe fn unfilled_mut(&mut self) -> &mut [MaybeUninit<T::Item>]

Get a mutable and possibly-uninitialized reference to all of the buffer.

Safety

The caller must not allow safe code to de-initialize the resulting slice.

pub unsafe fn advance(&mut self, count: usize)

Advance the counter of the number of items filled.

The number of items that are initialized is also updated accordingly, so that the number of items initialized is always greater than or equal to the number of items filled.

Safety

The caller must uphold the initialization invariant.

pub unsafe fn advance_all(&mut self)

Advance the counter of the number of items filled, and the number of items initialized, to the end of the buffer.

Safety

The caller must uphold the initialization invariant.

pub fn revert_to_start(&mut self)

pub fn fill_by_repeating(&mut self, item: T::Item)

where T::Item: Copy,

pub fn append(&mut self, slice: &[T::Item])

where T::Item: Copy,

impl<T> BufferRef<'_, T>

where T: Initialize<Item = u8>,

pub fn fill_by_zeroing(&mut self)