Struct gf::support::buffer::BufferPage

#[repr(C)]pub struct BufferPage {
    pub data: [u8; 4096],
    pub mask: [u8; 4096],
}

A fixed-size buffer page.

Fields

data: [u8; 4096]

Page data.

mask: [u8; 4096]

Page mask.

Implementations

impl BufferPage

pub const SIZE_BITS: usize

Page size in bits.

pub const SIZE_BITS_LOG2: usize

Page size in bits as power of two.

pub const SIZE_BYTES: usize

Page size in bytes.

pub const SIZE_BYTES_LOG2: usize

Page size in bytes as power of two.

pub fn new() -> Self

Construct an entirely undefined page.

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

Return bit value at bit_index, None if undefined.

Errors

• Panics on out-of-bound indexing.

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

Return byte value at byte_index, None if byte has undefined bits.

Errors

• Panics on out-of-bound indexing.

pub fn get_bytes(&self, byte_index: usize, num_bytes: usize) -> Option<&[u8]>

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

Errors

• Panics on out-of-bound indexing.

pub fn set_bit(&mut self, bit_index: usize, value: bool)

Set bit value at bit_index to value.

Errors

• Panics on out-of-bound indexing.

pub fn set_byte(&mut self, byte_index: usize, value: u8)

Set byte value at byte_index to value.

Errors

• Panics on out-of-bound indexing.

pub fn set_bytes(&mut self, byte_index: usize, slice: &[u8])

Set bytes starting at byte_index from a slice.

Errors

• Panics on out-of-bound indexing.

pub fn unset_bit(&mut self, bit_index: usize)

Unset bit at bit_index.

Errors

• Panics on out-of-bound indexing.

pub fn unset_byte(&mut self, byte_index: usize)

Unset byte at byte_index.

Errors

• Panics on out-of-bound indexing.

pub fn unset_bytes(&mut self, byte_index: usize, byte_count: usize)

Unset byte_count bytes starting at byte_index.

Errors

• Panics on out-of-bound indexing.

Trait Implementations

impl Clone for BufferPage

fn clone(&self) -> BufferPage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for BufferPage

fn default() -> Self

Returns the "default value" for a type.