Struct rubidium::SimpleVolAddr

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

Represents a simple MMIO address that can be safely read or 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 addresses using this type are "plain" addresses.

• Reads will just get the current value (without any other side effect).
• Writes will set a new value without changing any other memory of the system (though usually there's a hardware side effect).
• If you perform a write, and then you immediately perform a read, you'll read back exactly whatever you just wrote (the same as with normal memory).

For addresses where there's anything weird going on (read-only, write-only, read and write represent different effects, etc) then other volatile address types are used.

Note: values of this type can safely alias one another.

Methods

impl<T> SimpleVolAddr<T>

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

Reads the current value at the address.

pub fn write(&self, t: T) where
    T: Copy, 

Writes a new value to the address.

Trait Implementations

impl<T: Clone> Clone for SimpleVolAddr<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for SimpleVolAddr<T>

impl<T: Debug> Debug for SimpleVolAddr<T>

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

Formats the value using the given formatter.

impl<T> Eq for SimpleVolAddr<T>

impl<T> PartialEq<SimpleVolAddr<T>> for SimpleVolAddr<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 !=.