Struct tock_registers::fields::Field

source · [−]

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

Expand description

Specific section of a register.

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

Fields

mask: Tshift: usize

Implementations

source

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

Check if one or more bits in a field are set

source

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

Read value of the field as an enum member

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

Trait Implementations

source

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

source

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

Auto Trait Implementations

impl<T, R> RefUnwindSafe for Field<T, R> where
R: RefUnwindSafe,
T: RefUnwindSafe,

impl<T, R> Send for Field<T, R> where
R: Send,
T: Send,

impl<T, R> Sync for Field<T, R> where
R: Sync,
T: Sync,

impl<T, R> Unpin for Field<T, R> where
R: Unpin,
T: Unpin,

impl<T, R> UnwindSafe for Field<T, R> where
R: UnwindSafe,
T: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct tock_registers::fields::Field

Fields

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

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

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

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

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

Auto Trait Implementations

impl<T, R> RefUnwindSafe for Field<T, R> where R: RefUnwindSafe, T: RefUnwindSafe,

impl<T, R> Send for Field<T, R> where R: Send, T: Send,

impl<T, R> Sync for Field<T, R> where R: Sync, T: Sync,

impl<T, R> Unpin for Field<T, R> where R: Unpin, T: Unpin,

impl<T, R> UnwindSafe for Field<T, R> where R: UnwindSafe, T: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T, R> RefUnwindSafe for Field<T, R> where
R: RefUnwindSafe,
T: RefUnwindSafe,

impl<T, R> Send for Field<T, R> where
R: Send,
T: Send,

impl<T, R> Sync for Field<T, R> where
R: Sync,
T: Sync,

impl<T, R> Unpin for Field<T, R> where
R: Unpin,
T: Unpin,

impl<T, R> UnwindSafe for Field<T, R> where
R: UnwindSafe,
T: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,