Struct RegArray

pub struct RegArray<'a, P: ArrayElem<'a>, const N: usize> { /* private fields */ }

An array of registers.

Element type can be:

• a basic register of type Reg;
• a custom register map (struct) implementing the trait RegMapPtr through the derive macro RegMap;
• another RegArray (multidimensional array).

Implementations

impl<'a, P: ArrayElem<'a>, const N: usize> RegArray<'a, P, N>

pub const fn as_ptr(&self) -> *mut [P::Target; N]

Returns a raw pointer to the underlying pointer array.

pub const fn len(&self) -> usize

Returns the number of pointers in the array.

pub fn idx(&self, index: usize) -> P

Access the pointer at index.

Panics

If index is out of bounds, i.e. if index >= N.

pub unsafe fn idx_unchecked(&self, index: usize) -> P

Access the pointer at index, without doing bounds checking.

Safety

index must be in bounds: index < N.

pub fn iter( &self, ) -> impl 'a + ExactSizeIterator<Item = P> + DoubleEndedIterator + FusedIterator + Clone

Returns an iterator over the pointer array.

pub fn iter_slice( &self, start: usize, end: usize, ) -> impl 'a + ExactSizeIterator<Item = P> + DoubleEndedIterator + FusedIterator + Clone

Returns an iterator over a subslice [start..end] of the pointer array.

Panics

If [start..end] is out of bounds.

Trait Implementations

impl<'a, T: ArrayElem<'a>, const N: usize> ArrayElem<'a> for RegArray<'a, T, N>

type Target = [<T as ArrayElem<'a>>::Target; N]

The target type of the pointer stored in the array.

unsafe fn from_nonnull(ptr: NonNull<Self::Target>) -> Self

Creates a new pointer to Self::Target.