Struct voladdress::VolAddress

#[repr(transparent)]pub struct VolAddress<T, R, W> { /* fields omitted */ }

A volatile address.

This type stores a memory address and provides ergonomic volatile access to said memory address.

Generic Parameters

• T: The type of the value stored at the address.
  • The target type type must impl Copy for reading and writing to be allowed.
• R: If the address is readable.
  • If R=Safe then you can safely read from the address.
  • If R=Unsafe then you can unsafely read from the address.
  • Otherwise you cannot read from the address.
• W: If the address is writable.
  • If W=Safe then you can safely write to the address.
  • If W=Unsafe then you can unsafely write to the address.
  • Otherwise you cannot write to the address.

The VolAddress type is intended to represent a single value of a T type that is the size of a single machine register (or less).

• If there’s an array of contiguous T values you want to model, consider using VolBlock instead.
• If there’s a series of strided T values you want to model, consider using VolSeries instead.
• If the T type is larger than a single machine register it’s probably not a good fit for the VolAddress abstraction.

Safety

This type’s safety follows the “unsafe creation, then safe use” strategy.

• Validity Invariant: The address of a VolAddress must always be non-zero, or you will instantly trigger UB.
• Safety Invariant: The address of a VolAddress must be an aligned and legal address for a T type value (with correct R and W permissions) within the device’s memory space, otherwise the read and write methods will trigger UB when called.

Implementations

impl<T, R, W> VolAddress<T, R, W>

#[must_use]pub const unsafe fn new(address: usize) -> Self

Constructs the value.

Safety

• As per the type docs.

#[must_use]pub const unsafe fn cast<Z>(self) -> VolAddress<Z, R, W>

Changes the target type from T to Z.

Safety

• As per the type docs

#[must_use]pub const fn as_usize(self) -> usize

Converts the VolAddress back into a normal usize value.

#[must_use]pub const unsafe fn add(self, count: usize) -> Self

Advances the pointer by the given number of positions (usize).

Shorthand for addr.offset(count as isize)

This is intended to basically work like <*mut T>::wrapping_add.

Safety

• As per the type docs

#[must_use]pub const unsafe fn sub(self, count: usize) -> Self

Reverses the pointer by the given number of positions (usize).

Shorthand for addr.offset((count as isize).wrapping_neg())

This is intended to basically work like <*mut T>::wrapping_sub.

Safety

• As per the type docs

#[must_use]pub const unsafe fn offset(self, count: isize) -> Self

Offsets the address by the given number of positions (isize).

This is intended to basically work like <*mut T>::wrapping_offset.

Safety

• As per the type docs

impl<T, W> VolAddress<T, Safe, W> where
    T: Copy, 

#[must_use]pub fn read(self) -> T

Volatile reads the current value of A.

impl<T, W> VolAddress<T, Unsafe, W> where
    T: Copy, 

#[must_use]pub unsafe fn read(self) -> T

Volatile reads the current value of A.

Safety

• The safety rules of reading this address depend on the device. Consult your hardware manual.

impl<T, R> VolAddress<T, R, Safe> where
    T: Copy, 

pub fn write(self, t: T)

Volatile writes a new value to A.

impl<T, R> VolAddress<T, R, Unsafe> where
    T: Copy, 

pub unsafe fn write(self, t: T)

Volatile writes a new value to A.

Safety

• The safety rules of reading this address depend on the device. Consult your hardware manual.

Trait Implementations

impl<T, R, W> Clone for VolAddress<T, R, W>

#[must_use]fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, R, W> Copy for VolAddress<T, R, W>

impl<T, R, W> Debug for VolAddress<T, R, W>

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

Formats the value using the given formatter.

impl<T: Eq, R: Eq, W: Eq> Eq for VolAddress<T, R, W>

impl<T: Hash, R: Hash, W: Hash> Hash for VolAddress<T, R, W>

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

Feeds this value into the given Hasher.

pub 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> Ord for VolAddress<T, R, W>

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: PartialEq, R: PartialEq, W: PartialEq> PartialEq<VolAddress<T, R, W>> for VolAddress<T, R, W>

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

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

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

This method tests for !=.

impl<T: PartialOrd, R: PartialOrd, W: PartialOrd> PartialOrd<VolAddress<T, R, W>> for VolAddress<T, R, W>

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

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

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

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

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

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

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

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

#[must_use]pub 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> StructuralEq for VolAddress<T, R, W>

impl<T, R, W> StructuralPartialEq for VolAddress<T, R, W>