Struct register::LocalRegisterCopy

pub struct LocalRegisterCopy<T, R = ()> where
    T: IntLike,
    R: RegisterLongName,  { /* fields omitted */ }

A read-only copy register contents

This behaves very similarly to a read-only register, but instead of doing a volatile read to MMIO to get the value for each function call, a copy of the register contents are stored locally in memory. This allows a peripheral to do a single read on a register, and then check which bits are set without having to do a full MMIO read each time. It also allows the value of the register to be "cached" in case the peripheral driver needs to clear the register in hardware yet still be able to check the bits.

Implementations

impl<T, R> LocalRegisterCopy<T, R> where
    T: IntLike,
    R: RegisterLongName, 

pub const fn new(value: T) -> LocalRegisterCopy<T, R>

pub fn get(&self) -> T

pub fn read(&self, field: Field<T, R>) -> T

pub fn read_as_enum<E>(&self, field: Field<T, R>) -> Option<E> where
    E: TryFromValue<T, EnumType = E>, 

pub fn is_set(&self, field: Field<T, R>) -> bool

pub fn matches_any(&self, field: FieldValue<T, R>) -> bool

pub fn matches_all(&self, field: FieldValue<T, R>) -> bool

pub fn bitand(&self, rhs: T) -> LocalRegisterCopy<T, R>

Do a bitwise AND operation of the stored value and the passed in value and return a new LocalRegisterCopy.

Trait Implementations

impl<T, R> Clone for LocalRegisterCopy<T, R> where
    T: IntLike + Clone,
    R: RegisterLongName + Clone, 

pub fn clone(&self) -> LocalRegisterCopy<T, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, R> Copy for LocalRegisterCopy<T, R> where
    T: IntLike + Copy,
    R: RegisterLongName + Copy, 

impl<T, R> Debug for LocalRegisterCopy<T, R> where
    T: IntLike + Debug,
    R: RegisterLongName, 

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

Formats the value using the given formatter.