Struct voladdress::VolSeries

#[repr(transparent)]
pub struct VolSeries<T, R, W, const C: usize, const S: usize> { /* fields omitted */ }

A volatile memory “series”.

This is intended to model when a portion of memory is a series of evenly spaced values that are not directly contiguous.

Generic Parameters

• T / R / W: These parameters are applied to the VolAddress type returned when accessing the series in any way (indexing, iteration, etc).
• C: the count of elements in the series.
• S: the stride in bytes between series elements.

Safety

• This type stores a VolAddress internally, and so you must follow all of those safety rules. Notably, the base address must never be zero.
• The address space must legally contain C values of the T type, spaced every S bytes, starting from the base address.
• The memory series must not wrap around the end of the address space.

Implementations

impl<T, R, W, const C: usize, const S: usize> VolSeries<T, R, W, C, S>

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

Constructs the value.

Safety

• As per the type docs.

pub const fn len(self) -> usize

The length of this series (in elements).

pub const fn stride(self) -> usize

The stride of this series (in bytes).

pub const fn index(self, i: usize) -> VolAddress<T, R, W>

Indexes to the ith position of the memory series.

Panics

• If the index is out of bounds this will panic.

pub const fn get(self, i: usize) -> Option<VolAddress<T, R, W>>

Gets the address of the ith position, if it’s in bounds.

pub const fn iter(self) -> VolSeriesIter<T, R, W, S>

Creates an iterator over the addresses of the memory series.

pub fn iter_range<RB: RangeBounds<usize>>(
    self,
    r: RB
) -> VolSeriesIter<T, R, W, S>

Makes an iterator over the range bounds given.

If the range given is empty then your iterator will be empty.

Panics

• If the start or end of the range are out of bounds for the series.

Trait Implementations

impl<T, R, W, const C: usize, const S: usize> Clone for VolSeries<T, R, W, 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, R, W, const C: usize, const S: usize> Debug for VolSeries<T, R, W, C, S>

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

Formats the value using the given formatter.

impl<T: Hash, R: Hash, W: Hash, const C: usize, const S: usize> Hash for VolSeries<T, R, W, C, S>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T: Ord, R: Ord, W: Ord, const C: usize, const S: usize> Ord for VolSeries<T, R, W, C, S>

fn cmp(&self, other: &VolSeries<T, R, W, C, S>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: PartialEq, R: PartialEq, W: PartialEq, const C: usize, const S: usize> PartialEq<VolSeries<T, R, W, C, S>> for VolSeries<T, R, W, C, S>

fn eq(&self, other: &VolSeries<T, R, W, C, S>) -> bool

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

fn ne(&self, other: &VolSeries<T, R, W, C, S>) -> bool

This method tests for !=.

impl<T: PartialOrd, R: PartialOrd, W: PartialOrd, const C: usize, const S: usize> PartialOrd<VolSeries<T, R, W, C, S>> for VolSeries<T, R, W, C, S>

fn partial_cmp(&self, other: &VolSeries<T, R, W, C, S>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T, R, W, const C: usize, const S: usize> Copy for VolSeries<T, R, W, C, S>

impl<T: Eq, R: Eq, W: Eq, const C: usize, const S: usize> Eq for VolSeries<T, R, W, C, S>

impl<T, R, W, const C: usize, const S: usize> StructuralEq for VolSeries<T, R, W, C, S>

impl<T, R, W, const C: usize, const S: usize> StructuralPartialEq for VolSeries<T, R, W, C, S>