Struct voladdress::VolSeries

pub struct VolSeries<T, C: Unsigned, S: Unsigned> { /* fields omitted */ }

A series of evenly strided addresses.

• The C parameter is the element count of the series.
• The S parameter is the stride (in bytes) from one element to the next.

This is for when you have something like "a series of 128 u16 values every 16 bytes starting at 0x700_0000".

Methods

impl<T, C: Unsigned, S: Unsigned> VolSeries<T, C, S>

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

Constructs a new VolSeries.

Safety

The given address must be a valid VolAddress at each position in the series for however many slots (C), strided by the selected amount (S).

pub const fn len(self) -> usize

The length of this series (in elements)

Important traits for VolStridingIter<T, S>

impl<T, S: Unsigned> Iterator for VolStridingIter<T, S> type Item = VolAddress<T>;

pub const fn iter(self) -> VolStridingIter<T, S>

Gives an iterator over the slots of this series.

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

Unchecked indexing into the series.

Safety

The slot given must be in bounds.

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

Checked "indexing" style access into the series, giving either a VolAddress or a panic.

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

Checked "getting" style access into the series, giving an Option value.

Trait Implementations

impl<T, C: Unsigned, S: Unsigned> Clone for VolSeries<T, C, S>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, C: Unsigned, S: Unsigned> Debug for VolSeries<T, C, S>

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

Formats the value using the given formatter.

impl<T, C: Unsigned, S: Unsigned> PartialEq<VolSeries<T, C, S>> for VolSeries<T, C, S>

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 !=.

impl<T, C: Unsigned, S: Unsigned> Eq for VolSeries<T, C, S>

impl<T, C: Unsigned, S: Unsigned> Copy for VolSeries<T, C, S>