Struct tock_registers::fields::FieldValue

pub struct FieldValue<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: RegisterLongName> FieldValue<u8, R>

pub const fn new(mask: u8, shift: usize, value: u8) -> Self

impl<R: RegisterLongName> FieldValue<u16, R>

pub const fn new(mask: u16, shift: usize, value: u16) -> Self

impl<R: RegisterLongName> FieldValue<u32, R>

pub const fn new(mask: u32, shift: usize, value: u32) -> Self

impl<R: RegisterLongName> FieldValue<u64, R>

pub const fn new(mask: u64, shift: usize, value: u64) -> Self

impl<R: RegisterLongName> FieldValue<u128, R>

pub const fn new(mask: u128, shift: usize, value: u128) -> Self

impl<R: RegisterLongName> FieldValue<usize, R>

pub const fn new(mask: usize, shift: usize, value: usize) -> Self

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

pub fn none() -> Self

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: UIntLike, R: RegisterLongName> Add for FieldValue<T, R>

type Output = FieldValue<T, R>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl<T: UIntLike, R: RegisterLongName> AddAssign for FieldValue<T, R>

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

Performs the += operation.

impl<T: Clone + UIntLike, R: Clone + RegisterLongName> Clone for FieldValue<T, R>

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<R: RegisterLongName> From<FieldValue<u128, R>> for u128

fn from(val: FieldValue<u128, R>) -> u128

Converts to this type from the input type.

impl<R: RegisterLongName> From<FieldValue<u16, R>> for u16

fn from(val: FieldValue<u16, R>) -> u16

Converts to this type from the input type.

impl<R: RegisterLongName> From<FieldValue<u32, R>> for u32

fn from(val: FieldValue<u32, R>) -> u32

Converts to this type from the input type.

impl<R: RegisterLongName> From<FieldValue<u64, R>> for u64

fn from(val: FieldValue<u64, R>) -> u64

Converts to this type from the input type.

impl<R: RegisterLongName> From<FieldValue<u8, R>> for u8

fn from(val: FieldValue<u8, R>) -> u8

Converts to this type from the input type.

impl<R: RegisterLongName> From<FieldValue<usize, R>> for usize

fn from(val: FieldValue<usize, R>) -> usize

Converts to this type from the input type.

impl<T: Copy + UIntLike, R: Copy + RegisterLongName> Copy for FieldValue<T, R>