Struct voladdress::write_only::WOVolSeries

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

A series of evenly strided addresses, write only.

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

Methods

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

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

Constructs a new WOVolSeries.

Safety

The given address must be a valid WOVolAddress 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 WOVolStridingIter<T, S>

impl<T, S: Unsigned> Iterator for WOVolStridingIter<T, S> type Item = WOVolAddress<T>;

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

Gives an iterator over the slots of this series.

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

Unchecked indexing into the series.

Safety

The slot given must be in bounds.

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

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

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

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

Trait Implementations

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

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

Formats the value using the given formatter.

impl<T, C: Unsigned, S: Unsigned> PartialEq<WOVolSeries<T, C, S>> for WOVolSeries<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 WOVolSeries<T, C, S>

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

impl<T, C: Unsigned, S: Unsigned> Clone for WOVolSeries<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.