Struct cl_generic_vec::GenericReadBufRef

source · [−]

pub struct GenericReadBufRef<'a, S: Storage<Item = u8> + ?Sized> { /* private fields */ }

Expand description

A wrapper around &mut GenericReadBuf which prevents the buffer that the GenericReadBuf points to from being replaced.

Implementations

source

impl<'a, S: Storage<Item = u8> + ?Sized> GenericReadBufRef<'a, S>

source

pub fn reborrow(&mut self) -> GenericReadBufRef<'_, S>

Creates a new ReadBufRef referencing the same ReadBuf as this one.

source

pub fn filled_mut(&mut self) -> &mut [u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Returns a mutable reference to the filled portion of the buffer.

source

pub fn initialized_mut(&mut self) -> &mut [u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Returns a mutable reference to the initialized portion of the buffer.

This includes the filled portion.

source

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

Returns a mutable reference to the unfilled 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.

source

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

Returns a mutable reference to the uninitialized part of the buffer.

It is safe to uninitialize any of these bytes.

source

pub fn initialize_unfilled(&mut self) -> &mut [u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Returns a mutable reference to the unfilled part of the buffer, ensuring it is fully initialized.

Since ReadBuf tracks the region of the buffer that has been initialized, this is effectively “free” after the first use.

source

pub fn initialize_unfilled_to(&mut self, n: usize) -> &mut [u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Returns a mutable reference to the first n bytes of the unfilled part of the buffer, ensuring it is fully initialized.

Panics

Panics if self.remaining() is less than n.

source

pub fn clear(&mut self)

Clears the buffer, resetting the filled region to empty.

The number of initialized bytes is not changed, and the contents of the buffer are not modified.

source

pub fn add_filled(&mut self, n: usize)

Increases the size of the filled region of the buffer.

The number of initialized bytes is not changed.

Panics

Panics if the filled region of the buffer would become larger than the initialized region.

source

pub fn set_filled(&mut self, n: usize)

Sets the size of the filled region of the buffer.

The number of initialized bytes is not changed.

Note that this can be used to shrink the filled region of the buffer in addition to growing it (for example, by a Read implementation that compresses data in-place).

Panics

Panics if the filled region of the buffer would become larger than the initialized region.

source

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

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

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