Struct tock_registers::fields::Field

pub struct Field<T: UIntLike, R: RegisterLongName> {
    pub mask: T,
    pub shift: usize,
    // some fields omitted
}

Specific section of a register.

For the Field, the mask is unshifted, ie. the LSB should always be set.

Fields

mask: T

shift: usize

Implementations

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

pub const fn new(mask: T, shift: usize) -> Field<T, R>

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

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

Check if one or more bits in a field are set

pub fn read_as_enum<E: TryFromValue<T, EnumType = E>>(self, val: T) -> Option<E>

Read value of the field as an enum member

impl<R: RegisterLongName> Field<u8, R>

pub fn val(&self, value: u8) -> FieldValue<u8, R>

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

pub fn val(&self, value: u16) -> FieldValue<u16, R>

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

pub fn val(&self, value: u32) -> FieldValue<u32, R>

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

pub fn val(&self, value: u64) -> FieldValue<u64, R>

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

pub fn val(&self, value: u128) -> FieldValue<u128, R>

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

pub fn val(&self, value: usize) -> FieldValue<usize, R>

Trait Implementations

impl<T: UIntLike, R: RegisterLongName> Clone for Field<T, R>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: UIntLike, R: RegisterLongName> Copy for Field<T, R>