Struct rubidium::ReadOnlyVolAddr

#[repr(transparent)]pub struct ReadOnlyVolAddr<T> { /* fields omitted */ }

Represents an MMIO address that can be safely read, but not written.

Unlike with raw pointers, this type favors unsafe construction and then assumes that all usage is safe once the value has been constructed.

The convention is that reading the address will have no side effects. However, the register can be changed by non-CPU parts of the hardware, and so each time you perform a read the value might have changed.

For addresses where reads have a side effect, other types are used.

Methods

impl<T> ReadOnlyVolAddr<T>

#[must_use]pub fn read(&self) -> T where
    T: Copy, 

Reads the current value at the address.

Trait Implementations

impl<T: Clone> Clone for ReadOnlyVolAddr<T>

fn clone(&self) -> ReadOnlyVolAddr<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for ReadOnlyVolAddr<T>

impl<T: Debug> Debug for ReadOnlyVolAddr<T>

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

Formats the value using the given formatter.

impl<T> Eq for ReadOnlyVolAddr<T>

impl<T> PartialEq<ReadOnlyVolAddr<T>> for ReadOnlyVolAddr<T>

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