Struct tock_registers::registers::InMemoryRegister

#[repr(transparent)]
pub struct InMemoryRegister<T: UIntLike, R: RegisterLongName = ()> { /* fields omitted */ }

In memory volatile register.

Like ReadWrite, but can be safely constructed using the InMemoryRegister::new method. It will always be initialized to the passed in, well-defined initial value.

For accessing and manipulating the register contents, the Readable, Writeable and ReadWriteable traits are implemented.

Implementations

impl<T: UIntLike, R: RegisterLongName> InMemoryRegister<T, R>

pub const fn new(value: T) -> Self

Trait Implementations

impl<T: UIntLike, R: RegisterLongName> Readable for InMemoryRegister<T, R>

type T = T

type R = R

fn get(&self) -> Self::T

Get the raw register value

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

Read the value of the given field

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

Set the raw register value

fn extract(&self) -> LocalRegisterCopy<Self::T, Self::R>

Make a local copy of the register

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

Check if one or more bits in a field are set

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

Check if any specified parts of a field match

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

Check if all specified parts of a field match

impl<T: UIntLike, R: RegisterLongName> Writeable for InMemoryRegister<T, R>

type T = T

type R = R

fn set(&self, value: T)

Set the raw register value

fn write(&self, field: FieldValue<Self::T, Self::R>)

Write the value of one or more fields, overwriting the other fields with zero

fn modify_no_read(
    &self,
    original: LocalRegisterCopy<Self::T, Self::R>,
    field: FieldValue<Self::T, Self::R>
)

Write the value of one or more fields, maintaining the value of unchanged fields via a provided original value, rather than a register read.