Struct kernel::utilities::registers::FieldValue

pub struct FieldValue<T, R>
where
    T: UIntLike,
    R: RegisterLongName,
{
    pub value: T,
    /* private fields */
}

Values for the specific register fields.

For the FieldValue, the masks and values are shifted into their actual location in the register.

Fields

value: T

Implementations

impl<R> FieldValue<u8, R>

where R: RegisterLongName,

pub const fn new(mask: u8, shift: usize, value: u8) -> FieldValue<u8, R>

impl<R> FieldValue<u16, R>

where R: RegisterLongName,

pub const fn new(mask: u16, shift: usize, value: u16) -> FieldValue<u16, R>

impl<R> FieldValue<u32, R>

where R: RegisterLongName,

pub const fn new(mask: u32, shift: usize, value: u32) -> FieldValue<u32, R>

impl<R> FieldValue<u64, R>

where R: RegisterLongName,

pub const fn new(mask: u64, shift: usize, value: u64) -> FieldValue<u64, R>

impl<R> FieldValue<u128, R>

where R: RegisterLongName,

pub const fn new(mask: u128, shift: usize, value: u128) -> FieldValue<u128, R>

impl<R> FieldValue<usize, R>

where R: RegisterLongName,

pub const fn new( mask: usize, shift: usize, value: usize, ) -> FieldValue<usize, R>

impl<T, R> FieldValue<T, R>

where T: UIntLike, R: RegisterLongName,

pub fn none() -> FieldValue<T, R>

pub const fn mask(&self) -> T

Get the raw bitmask represented by this FieldValue.

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

pub fn modify(self, val: T) -> T

Modify fields in a register value

pub fn any_matching_bits_set(&self, val: T) -> bool

Check if any of the bits covered by the mask for this FieldValue and set in the FieldValue are also set in the passed value

pub fn matches_all(&self, val: T) -> bool

Check if all specified parts of a field match

Trait Implementations

impl<T, R> Add for FieldValue<T, R>

where T: UIntLike, R: RegisterLongName,

type Output = FieldValue<T, R>

The resulting type after applying the + operator.

fn add(self, rhs: FieldValue<T, R>) -> FieldValue<T, R>

Performs the + operation.

impl<T, R> AddAssign for FieldValue<T, R>

where T: UIntLike, R: RegisterLongName,

fn add_assign(&mut self, rhs: FieldValue<T, R>)

Performs the += operation.

impl<T, R> Clone for FieldValue<T, R>

where T: Clone + UIntLike, R: Clone + RegisterLongName,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Value> for FieldValue<u16, Register>

fn from(v: Value) -> Self

Converts to this type from the input type.

impl<T, R> Copy for FieldValue<T, R>

where T: Copy + UIntLike, R: Copy + RegisterLongName,