Struct RegisterFieldValue 

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

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 const fn new(field: RegisterField<u8>, value: u8) -> Self

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

pub const fn from_raw(field: RegisterField<u8>, raw_value: u8) -> Self

Create a new fieldvalue based on the field definition and the raw 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 const fn new(field: RegisterField<u16>, value: u16) -> Self

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

pub const fn from_raw(field: RegisterField<u16>, raw_value: u16) -> Self

Create a new fieldvalue based on the field definition and the raw 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 const fn new(field: RegisterField<u32>, value: u32) -> Self

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

pub const fn from_raw(field: RegisterField<u32>, raw_value: u32) -> Self

Create a new fieldvalue based on the field definition and the raw 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 const fn new(field: RegisterField<u64>, value: u64) -> Self

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

pub const fn from_raw(field: RegisterField<u64>, raw_value: u64) -> Self

Create a new fieldvalue based on the field definition and the raw 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 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 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 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 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 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 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 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 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 duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RegisterFieldValue<u16>

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

Formats the value using the given formatter.

impl Debug for RegisterFieldValue<u32>

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

Formats the value using the given formatter.

impl Debug for RegisterFieldValue<u64>

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

Formats the value using the given formatter.

impl Debug for RegisterFieldValue<u8>

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

Formats the value using the given formatter.

impl PartialEq for RegisterFieldValue<u16>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for RegisterFieldValue<u32>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for RegisterFieldValue<u64>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for RegisterFieldValue<u8>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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