Struct bounded_registers::Field

pub struct Field<W, M, O, U, R> where
    U: IsGreater<U0, Output = True>,  { /* fields omitted */ }

A field in a register parameterized by its mask, offset, and upper bound. To construct a field, its val must be ⩽ U::U32.

It uses these type-level numbers so that the mask and offset can be constant.

Methods

impl<W, M: Unsigned, O: Unsigned, U: Unsigned, R> Field<W, M, O, U, R> where
    U: IsGreater<U0, Output = True> + ReifyTo<W>,
    W: Copy + Clone + PartialOrd + BitAnd<W, Output = W> + Shr<W, Output = W> + Default,
    U: ReifyTo<W>,
    U0: ReifyTo<W>, 

pub fn new(val: W) -> Option<Self>

New returns a Some(Field) if the given value is less than or equal to its upper bound, otherwise it returns None.

pub fn set(self, val: W) -> Option<Self>

set takes an existing field sets its value to val. If val is not ⩽ U, it returns None.

pub fn val(&self) -> W

val retrieves the value from the field.

pub fn is_set(&self) -> bool

is_set returns whether or not the field's val is equal to its upper bound.

impl<M: Unsigned, O: Unsigned, U: Unsigned, R> Field<u8, M, O, U, R> where
    U: IsGreater<U0, Output = True>, 

pub const fn checked<V: Unsigned>() -> Self where
    V: IsLessOrEqual<U, Output = True>,
    V: IsGreaterOrEqual<U0, Output = True>, 

checked is a compile-time checked constructor for a Field. Its V parameter must be ⩽ U; if it is not, the program will fail to typecheck.

impl<M: Unsigned, O: Unsigned, U: Unsigned, R> Field<u16, M, O, U, R> where
    U: IsGreater<U0, Output = True>, 

pub const fn checked<V: Unsigned>() -> Self where
    V: IsLessOrEqual<U, Output = True>,
    V: IsGreaterOrEqual<U0, Output = True>, 

checked is a compile-time checked constructor for a Field. Its V parameter must be ⩽ U; if it is not, the program will fail to typecheck.

impl<M: Unsigned, O: Unsigned, U: Unsigned, R> Field<u32, M, O, U, R> where
    U: IsGreater<U0, Output = True>, 

pub const fn checked<V: Unsigned>() -> Self where
    V: IsLessOrEqual<U, Output = True>,
    V: IsGreaterOrEqual<U0, Output = True>, 

checked is a compile-time checked constructor for a Field. Its V parameter must be ⩽ U; if it is not, the program will fail to typecheck.

impl<M: Unsigned, O: Unsigned, U: Unsigned, R> Field<u64, M, O, U, R> where
    U: IsGreater<U0, Output = True>, 

pub const fn checked<V: Unsigned>() -> Self where
    V: IsLessOrEqual<U, Output = True>,
    V: IsGreaterOrEqual<U0, Output = True>, 

checked is a compile-time checked constructor for a Field. Its V parameter must be ⩽ U; if it is not, the program will fail to typecheck.

impl<M: Unsigned, O: Unsigned, U: Unsigned, R> Field<usize, M, O, U, R> where
    U: IsGreater<U0, Output = True>, 

pub const fn checked<V: Unsigned>() -> Self where
    V: IsLessOrEqual<U, Output = True>,
    V: IsGreaterOrEqual<U0, Output = True>, 

checked is a compile-time checked constructor for a Field. Its V parameter must be ⩽ U; if it is not, the program will fail to typecheck.

Trait Implementations

impl<W, M: Unsigned, O: Unsigned, U: Unsigned, R> Positioned for Field<W, M, O, U, R> where
    U: IsGreater<U0, Output = True> + ReifyTo<W>,
    W: Copy + Clone + PartialOrd + BitAnd<W, Output = W> + Shr<W, Output = W> + Default + Shl<W, Output = W>,
    M: ReifyTo<W>,
    U0: ReifyTo<W>,
    O: ReifyTo<W>, 

type Width = W

fn mask(&self) -> W

The mask for this positioned value.

fn in_position(&self) -> W

Presents a value as its register-relative value.

impl<W: Debug, M: Debug, O: Debug, U: Debug, R: Debug> Debug for Field<W, M, O, U, R> where
    U: IsGreater<U0, Output = True>, 

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

Formats the value using the given formatter.

impl<W, M: Unsigned, O: Unsigned, U: Unsigned, R> PartialEq<Field<W, M, O, U, R>> for Field<W, M, O, U, R> where
    U: IsGreater<U0, Output = True> + ReifyTo<W>,
    W: Copy + Clone + PartialOrd + BitAnd<W, Output = W> + Shr<W, Output = W> + Default,
    U0: ReifyTo<W>, 

fn eq(&self, rhs: &Field<W, M, O, U, R>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<W, LM: Unsigned, LO: Unsigned, LU: Unsigned, LR, RM: Unsigned, RO: Unsigned, RU: Unsigned, RR> Add<Field<W, RM, RO, RU, RR>> for Field<W, LM, LO, LU, LR> where
    LU: IsGreater<U0, Output = True> + ReifyTo<W>,
    RU: IsGreater<U0, Output = True> + ReifyTo<W>,
    RO: ReifyTo<W>,
    LO: ReifyTo<W>,
    W: Copy + Clone + PartialOrd + BitAnd<W, Output = W> + Shr<W, Output = W> + Default + Shl<W, Output = W> + BitOr<W, Output = W>,
    U0: ReifyTo<W>,
    LM: BitOr<RM>,
    <LM as BitOr<RM>>::Output: ReifyTo<W>, 

type Output = FieldDisj<W>

The resulting type after applying the + operator.

fn add(self, rhs: Field<W, RM, RO, RU, RR>) -> Self::Output

Performs the + operation.

impl<W, M: Unsigned, O: Unsigned, U: Unsigned, R> Add<FieldDisj<W>> for Field<W, M, O, U, R> where
    U: IsGreater<U0, Output = True> + ReifyTo<W>,
    W: Copy + Clone + PartialOrd + BitAnd<W, Output = W> + Shr<W, Output = W> + Default + Shl<W, Output = W> + BitOr<W, Output = W>,
    U0: ReifyTo<W>,
    O: ReifyTo<W>,
    M: ReifyTo<W>, 

type Output = FieldDisj<W>

The resulting type after applying the + operator.

fn add(self, rhs: FieldDisj<W>) -> Self::Output

Performs the + operation.

impl<W, M: Unsigned, O: Unsigned, U: Unsigned, R> Add<Field<W, M, O, U, R>> for FieldDisj<W> where
    U: IsGreater<U0, Output = True> + ReifyTo<W>,
    W: Copy + Clone + PartialOrd + BitAnd<W, Output = W> + Shr<W, Output = W> + Default + Shl<W, Output = W> + BitOr<W, Output = W>,
    U0: ReifyTo<W>,
    O: ReifyTo<W>,
    M: ReifyTo<W>, 

type Output = FieldDisj<W>

The resulting type after applying the + operator.

fn add(self, rhs: Field<W, M, O, U, R>) -> Self::Output

Performs the + operation.