Struct gf::support::buffer::Buffer

pub struct Buffer { /* fields omitted */ }

A byte-granular buffer that can have undefined bits.

Internally, a buffer is a collection of fixed-size pages, each a BufferPage structure. Pages are allocated on-demand. Missing pages are defined to have no concrete bits.

Implementations

impl Buffer

pub fn new<I: Into<BufferSize>>(size: I) -> Self

Create an entirely undefined buffer.

pub fn size(&self) -> BufferSize

Return buffer size.

pub fn clear(&mut self)

Clear buffer, resetting all bits to undefined.

pub fn get_bit<I: IntoU128>(&self, bit_index: I) -> Option<bool>

Return bit value at bit_index, None if undefined.

Errors

• Panics on out-of-bound indexing.

pub fn get_byte<I: IntoU128>(&self, byte_index: I) -> Option<u8>

Return byte value at byte_index, None if undefined.

Errors

• Panics on out-of-bound indexing.

pub fn get_bytes<I: IntoU128>(
    &self,
    byte_index: I,
    num_bytes: usize
) -> Option<Vec<u8>>

Return values of num_bytes bytes starting at byte_index as a vector, None if any of the bytes is undefined.

Errors

• Panics on out-of-bound indexing.

#[must_use = "check return value before accessing the slice"]pub fn get_bytes_into<I: IntoU128>(
    &self,
    byte_index: I,
    slice: &mut [u8]
) -> bool

Copy values of bytes starting at byte_index into a slice, returning whether all bytes have been defined.

If any of the bytes are undefined, the entire contents of the slice are undefined on exit from this function, so it is important to check the return value before doing anything with the slice.

Errors

• Panics on out-of-bound indexing.

pub fn set_bit<I: IntoU128>(&mut self, bit_index: I, value: bool)

Set bit value at bit_index to value.

Errors

• Panics on out-of-bound indexing.

pub fn set_byte<I: IntoU128>(&mut self, byte_index: I, value: u8)

Set byte value at byte_index to value.

Errors

• Panics on out-of-bound indexing.

pub fn set_bytes<I: IntoU128>(&mut self, byte_index: I, slice: &[u8])

Set values bytes starting at byte_index from a slice.

Errors

• Panics on out-of-bound indexing.

pub fn unset_bit<I: IntoU128>(&mut self, bit_index: I)

Unset bit at bit_index.

Errors

• Panics on out-of-bound indexing.

pub fn unset_byte<I: IntoU128>(&mut self, byte_index: I)

Unset byte at byte_index.

Errors

• Panics on out-of-bound indexing.

pub fn unset_bytes<I: IntoU128>(&mut self, byte_index: I, num_bytes: usize)

Unset num_bytes bytes starting at byte_index.

Errors

• Panics on out-of-bound indexing.

pub fn page_of_bit<I: IntoU128>(&self, bit_index: I) -> Option<&BufferPage>

Return a shared reference to page for bit_index, None if the entire page is undefined.

Errors

• Panics on out-of-bound indexing.

pub fn page_of_bit_mut<I: IntoU128>(&mut self, bit_index: I) -> &mut BufferPage

Return a mutable reference to page for bit_index, default-constructing it as needed.

Errors

• Panics on out-of-bound indexing.

pub fn page_of_byte<I: IntoU128>(&self, byte_index: I) -> Option<&BufferPage>

Return shared reference to page for byte_index, None if the entire page is undefined.

Errors

• Panics on out-of-bound indexing.

pub fn page_of_byte_mut<I: IntoU128>(
    &mut self,
    byte_index: I
) -> &mut BufferPage

Return mutable reference to page for byte_index, default-constructing it as needed.

Errors

• Panics on out-of-bound indexing.

Trait Implementations

impl Clone for Buffer

fn clone(&self) -> Buffer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.