Struct ruspiro_register::RegisterFieldValue

pub struct RegisterFieldValue<T: RegisterType> { /* fields omitted */ }

Definition of a specific fieldvalue of a regiser. This structure allows to combine field values with bit operators like | and & to build the final value that should be written to a register

Implementations

impl RegisterFieldValue<u8>

pub fn new(field: RegisterField<u8>, value: u8) -> Self

Create a new fieldvalue based on the field definition and the value given

pub fn value(&self) -> u8

Retrieve the register field value

pub fn raw_value(&self) -> u8

Retrieve the register field raw value, means the value is returned in it's position as it appears in the register when read with the field mask applied but not shifted

pub fn mask(&self) -> u8

Retrieve the field mask used with this register field. The mask is shifted to it's corresponding field position

impl RegisterFieldValue<u16>

pub fn new(field: RegisterField<u16>, value: u16) -> Self

Create a new fieldvalue based on the field definition and the value given

pub fn value(&self) -> u16

Retrieve the register field value

pub fn raw_value(&self) -> u16

Retrieve the register field raw value, means the value is returned in it's position as it appears in the register when read with the field mask applied but not shifted

pub fn mask(&self) -> u16

Retrieve the field mask used with this register field. The mask is shifted to it's corresponding field position

impl RegisterFieldValue<u32>

pub fn new(field: RegisterField<u32>, value: u32) -> Self

Create a new fieldvalue based on the field definition and the value given

pub fn value(&self) -> u32

Retrieve the register field value

pub fn raw_value(&self) -> u32

Retrieve the register field raw value, means the value is returned in it's position as it appears in the register when read with the field mask applied but not shifted

pub fn mask(&self) -> u32

Retrieve the field mask used with this register field. The mask is shifted to it's corresponding field position

impl RegisterFieldValue<u64>

pub fn new(field: RegisterField<u64>, value: u64) -> Self

Create a new fieldvalue based on the field definition and the value given

pub fn value(&self) -> u64

Retrieve the register field value

pub fn raw_value(&self) -> u64

Retrieve the register field raw value, means the value is returned in it's position as it appears in the register when read with the field mask applied but not shifted

pub fn mask(&self) -> u64

Retrieve the field mask used with this register field. The mask is shifted to it's corresponding field position

Trait Implementations

impl BitAnd<RegisterFieldValue<u16>> for RegisterFieldValue<u16>

type Output = RegisterFieldValue<u16>

The resulting type after applying the & operator.

fn bitand(self, rhs: RegisterFieldValue<u16>) -> Self

Performs the & operation.

impl BitAnd<RegisterFieldValue<u32>> for RegisterFieldValue<u32>

type Output = RegisterFieldValue<u32>

The resulting type after applying the & operator.

fn bitand(self, rhs: RegisterFieldValue<u32>) -> Self

Performs the & operation.

impl BitAnd<RegisterFieldValue<u64>> for RegisterFieldValue<u64>

type Output = RegisterFieldValue<u64>

The resulting type after applying the & operator.

fn bitand(self, rhs: RegisterFieldValue<u64>) -> Self

Performs the & operation.

impl BitAnd<RegisterFieldValue<u8>> for RegisterFieldValue<u8>

type Output = RegisterFieldValue<u8>

The resulting type after applying the & operator.

fn bitand(self, rhs: RegisterFieldValue<u8>) -> Self

Performs the & operation.

impl BitOr<RegisterFieldValue<u16>> for RegisterFieldValue<u16>

type Output = RegisterFieldValue<u16>

The resulting type after applying the | operator.

fn bitor(self, rhs: RegisterFieldValue<u16>) -> Self

Performs the | operation.

impl BitOr<RegisterFieldValue<u32>> for RegisterFieldValue<u32>

type Output = RegisterFieldValue<u32>

The resulting type after applying the | operator.

fn bitor(self, rhs: RegisterFieldValue<u32>) -> Self

Performs the | operation.

impl BitOr<RegisterFieldValue<u64>> for RegisterFieldValue<u64>

type Output = RegisterFieldValue<u64>

The resulting type after applying the | operator.

fn bitor(self, rhs: RegisterFieldValue<u64>) -> Self

Performs the | operation.

impl BitOr<RegisterFieldValue<u8>> for RegisterFieldValue<u8>

type Output = RegisterFieldValue<u8>

The resulting type after applying the | operator.

fn bitor(self, rhs: RegisterFieldValue<u8>) -> Self

Performs the | operation.

impl<T: Clone + RegisterType> Clone for RegisterFieldValue<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy + RegisterType> Copy for RegisterFieldValue<T>

impl<T: Debug + RegisterType> Debug for RegisterFieldValue<T>

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

Formats the value using the given formatter.