Struct kernel::utilities::registers::InMemoryRegister

source ·
pub struct InMemoryRegister<T, R = ()>{ /* private fields */ }
Expand description

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§

source§

impl<T, R> InMemoryRegister<T, R>

source

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

Trait Implementations§

source§

impl<T, R> Readable for InMemoryRegister<T, R>

§

type T = T

§

type R = R

source§

fn get(&self) -> <InMemoryRegister<T, R> as Readable>::T

Get the raw register value
source§

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

Read the value of the given field
source§

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

Set the raw register value Read more
source§

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

Make a local copy of the register
source§

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

Check if one or more bits in a field are set
source§

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

Check if any bits corresponding to the mask in the passed FieldValue are set. This function is identical to is_set() but operates on a FieldValue rather than a Field, allowing for checking if any bits are set across multiple, non-contiguous portions of a bitfield.
source§

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

Check if all specified parts of a field match
source§

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

Check if any of the passed parts of a field exactly match the contained value. This allows for matching on unset bits, or matching on specific values in multi-bit fields.
source§

impl<T, R> Writeable for InMemoryRegister<T, R>

§

type T = T

§

type R = R

source§

fn set(&self, value: T)

Set the raw register value
source§

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

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

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.

Auto Trait Implementations§

§

impl<T, R = ()> !Freeze for InMemoryRegister<T, R>

§

impl<T, R = ()> !RefUnwindSafe for InMemoryRegister<T, R>

§

impl<T, R> Send for InMemoryRegister<T, R>
where T: Send, R: Send,

§

impl<T, R = ()> !Sync for InMemoryRegister<T, R>

§

impl<T, R> Unpin for InMemoryRegister<T, R>
where T: Unpin, R: Unpin,

§

impl<T, R> UnwindSafe for InMemoryRegister<T, R>
where T: UnwindSafe, R: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Debuggable for T
where T: Readable,

source§

fn debug(&self) -> RegisterDebugValue<Self::T, Self::R>
where Self::R: RegisterDebugInfo<Self::T>,

Returns a RegisterDebugValue that implements core::fmt::Debug, the debug information is extracted from <Register>::DebugInfo.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, R, S> ReadWriteable for S
where R: RegisterLongName, S: Readable<T = T, R = R> + Writeable<T = T, R = R>, T: UIntLike,

§

type T = T

§

type R = R

source§

fn modify( &self, field: FieldValue<<S as ReadWriteable>::T, <S as ReadWriteable>::R>, )

Write the value of one or more fields, leaving the other fields unchanged
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.