Struct voladdress::VolBlock

pub struct VolBlock<T, const COUNT: usize> { /* fields omitted */ }

A block of addresses all in a row.

• The C parameter is the element count of the block.

This is for if you have something like "a block of 256 u16 values all in a row starting at 0x500_0000".

Methods

impl<T, const COUNT: usize> VolBlock<T, COUNT>

pub const unsafe fn new(address: usize) -> Self

Constructs a new VolBlock.

Safety

The given address must be a valid VolAddress at each position in the block for however many slots (C).

pub const fn len(self) -> usize

The length of this block (in elements)

Important traits for VolIter<T>

impl<T> Iterator for VolIter<T> type Item = VolAddress<T>;

pub const fn iter(self) -> VolIter<T>

Gives an iterator over the slots of this block.

pub const unsafe fn index_unchecked(self, slot: usize) -> VolAddress<T>

Unchecked indexing into the block.

Safety

The slot given must be in bounds.

pub fn index(self, slot: usize) -> VolAddress<T>

Checked "indexing" style access of the block, giving either a VolAddress or a panic.

pub fn get(self, slot: usize) -> Option<VolAddress<T>>

Checked "getting" style access of the block, giving an Option value.

Trait Implementations

impl<T, const COUNT: usize> Clone for VolBlock<T, COUNT>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, const COUNT: usize> Copy for VolBlock<T, COUNT>

impl<T, const COUNT: usize> Debug for VolBlock<T, COUNT>

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

Formats the value using the given formatter.

impl<T, const COUNT: usize> Eq for VolBlock<T, COUNT>

impl<T, const COUNT: usize> PartialEq<VolBlock<T, COUNT>> for VolBlock<T, COUNT>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.