Struct FieldValues

pub struct FieldValues<R: RegisterValue, T = ()> { /* private fields */ }

Some fields’ values read from or to be written to a register

Created by:

• Combining (with |) fields values generated by the [periph!], [register!] or [field_type!] macros.
• Reg::fields or Value&Fields: read some fields from the register.
• Default or FieldValues::empty: no fields’ values.

Used with:

• Reg::modify or Value|FieldValues: change the value of the specified fields.

These field values can be combined together with |.

Example

use peripherals::{register, FieldValues, Fields, Value};

register! {
    Register: u8 = 0b1001 {
        BIT1: 0 = struct Bit1(bool);
        BIT2: 1 = struct Bit2(bool);
        TWO_BITS: 2..3 = struct TwoBits(u8);
    }
}

// Obtain it with the `empty` method or by combining field values
let empty = FieldValues::<Register>::empty();
assert_eq!(empty.bits(), 0b0000);
assert_eq!(empty.fields(), Fields::<Register>::empty());
let bits_12 = Bit1(false) | Bit2(true);
assert_eq!(bits_12.bits(), 0b0010);
assert_eq!(bits_12.fields(), Register::BIT1 | Register::BIT2);
let values = Bit1(true) | TwoBits(0b01);
assert_eq!(values.bits(), 0b0101);
assert_eq!(values.fields(), Register::BIT1 | Register::TWO_BITS);

// Use it to modify values
let mut value = Value::<Register>::reset();
assert_eq!(value.value(), 0b1001);
value |= bits_12;
assert_eq!(value.value(), 0b1010);
value |= values;
assert_eq!(value.value(), 0b0111);

Implementations

impl<R: RegisterValue, T> FieldValues<R, T>

pub fn bits(self) -> R::Int

Get the raw bits to set

pub fn mask(self) -> R::Int

Get the raw mask

pub fn fields(self) -> Fields<R, T>

Get the fields specified in this value

pub unsafe fn from_raw(bits: R::Int, mask: R::Int) -> FieldValues<R, T>

Build from raw bits and mask

Safety

You must ensure the value and mask are valid for the fields of the associated register.

pub fn empty() -> FieldValues<R, T>

No fields’ values (doesn’t change anything when used to modify a register)

Trait Implementations

impl<R: RegisterValue, T, U> BitAnd<T> for FieldValues<R, U>

where T: Either<U> + Into<Fields<R>>,

type Output = FieldValues<R, <T as Either<U>>::Output>

The resulting type after applying the & operator.

fn bitand(self, other: T) -> Self::Output

Performs the & operation.

impl<R: RegisterValue, T, U> BitAndAssign<T> for FieldValues<R, U>

where T: Either<U, Output = U> + Into<Fields<R>>,

fn bitand_assign(&mut self, other: T)

Performs the &= operation.

impl<R: RegisterValue, T, U> BitOr<T> for FieldValues<R, U>

where T: Both<U> + Into<FieldValues<R>>,

type Output = FieldValues<R, <T as Both<U>>::Output>

The resulting type after applying the | operator.

fn bitor(self, other: T) -> Self::Output

Performs the | operation.

impl<R: RegisterValue, T, U> BitOrAssign<T> for FieldValues<R, U>

where T: Both<U, Output = U> + Into<FieldValues<R>>,

fn bitor_assign(&mut self, other: T)

Performs the |= operation.

impl<R: RegisterValue, T, U> BitXor<T> for FieldValues<R, U>

where T: Either<U, Output = Toggle> + Into<Fields<R>>,

type Output = FieldValues<R, U>

The resulting type after applying the ^ operator.

fn bitxor(self, other: T) -> Self::Output

Performs the ^ operation.

impl<R: RegisterValue, T, U> BitXorAssign<T> for FieldValues<R, U>

where T: Either<U, Output = Toggle> + Into<Fields<R>>,

fn bitxor_assign(&mut self, other: T)

Performs the ^= operation.

impl<R: RegisterValue, T> Clone for FieldValues<R, T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: RegisterValue, T> Debug for FieldValues<R, T>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<R: RegisterValue, T> Default for FieldValues<R, T>

fn default() -> FieldValues<R, T>

Returns the “default value” for a type.

impl From<CfgFlag> for FieldValues<CONFIG, Toggle>

fn from(value: CfgFlag) -> FieldValues<CONFIG, Toggle>

Converts to this type from the input type.

impl From<Data> for FieldValues<BUFFER>

fn from(value: Data) -> FieldValues<BUFFER>

Converts to this type from the input type.

impl From<Data> for FieldValues<BigRegister>

fn from(value: Data) -> FieldValues<BigRegister>

Converts to this type from the input type.

impl From<Enum> for FieldValues<Register>

fn from(value: Enum) -> FieldValues<Register>

Converts to this type from the input type.

impl From<Enum> for FieldValues<Register>

fn from(value: Enum) -> FieldValues<Register>

Converts to this type from the input type.

impl From<Enum> for FieldValues<RegisterName>

fn from(value: Enum) -> FieldValues<RegisterName>

Converts to this type from the input type.

impl From<EnumAll> for FieldValues<RegisterAll>

all: on everything

fn from(value: EnumAll) -> FieldValues<RegisterAll>

Converts to this type from the input type.

impl From<EnumAll> for FieldValues<RegisterAll>

all: on everything

fn from(value: EnumAll) -> FieldValues<RegisterAll>

Converts to this type from the input type.

impl From<EnumField> for FieldValues<RegisterField>

fn from(value: EnumField) -> FieldValues<RegisterField>

Converts to this type from the input type.

impl From<EnumField> for FieldValues<RegisterField>

fn from(value: EnumField) -> FieldValues<RegisterField>

Converts to this type from the input type.

impl From<EnumImpl> for FieldValues<RegisterImpl>

impl: only on impls

fn from(value: EnumImpl) -> FieldValues<RegisterImpl>

Converts to this type from the input type.

impl From<EnumImpl> for FieldValues<RegisterImpl>

impl: only on impls

fn from(value: EnumImpl) -> FieldValues<RegisterImpl>

Converts to this type from the input type.

impl From<EnumType> for FieldValues<RegisterType>

fn from(value: EnumType) -> FieldValues<RegisterType>

Converts to this type from the input type.

impl From<EnumType> for FieldValues<RegisterType>

fn from(value: EnumType) -> FieldValues<RegisterType>

Converts to this type from the input type.

impl From<Extern> for FieldValues<Register>

fn from(value: Extern) -> FieldValues<Register>

Converts to this type from the input type.

impl From<ExternAll> for FieldValues<RegisterAll>

all: on everything

fn from(value: ExternAll) -> FieldValues<RegisterAll>

Converts to this type from the input type.

impl From<ExternField> for FieldValues<RegisterField>

fn from(value: ExternField) -> FieldValues<RegisterField>

Converts to this type from the input type.

impl From<ExternImpl> for FieldValues<RegisterImpl>

impl: only on impls

fn from(value: ExternImpl) -> FieldValues<RegisterImpl>

Converts to this type from the input type.

impl From<ExternType> for FieldValues<RegisterType>

fn from(value: ExternType) -> FieldValues<RegisterType>

Converts to this type from the input type.

impl From<Mode> for FieldValues<BigRegister>

fn from(value: Mode) -> FieldValues<BigRegister>

Converts to this type from the input type.

impl From<Mode> for FieldValues<CONFIG>

fn from(value: Mode) -> FieldValues<CONFIG>

Converts to this type from the input type.

impl From<Newtype> for FieldValues<Register, Toggle>

fn from(value: Newtype) -> FieldValues<Register, Toggle>

Converts to this type from the input type.

impl From<Newtype> for FieldValues<Register, Toggle>

fn from(value: Newtype) -> FieldValues<Register, Toggle>

Converts to this type from the input type.

impl From<Newtype> for FieldValues<RegisterName, Toggle>

fn from(value: Newtype) -> FieldValues<RegisterName, Toggle>

Converts to this type from the input type.

impl From<NewtypeAll> for FieldValues<RegisterAll, Toggle>

all: on everything

fn from(value: NewtypeAll) -> FieldValues<RegisterAll, Toggle>

Converts to this type from the input type.

impl From<NewtypeAll> for FieldValues<RegisterAll, Toggle>

all: on everything

fn from(value: NewtypeAll) -> FieldValues<RegisterAll, Toggle>

Converts to this type from the input type.

impl From<NewtypeField> for FieldValues<RegisterField, Toggle>

fn from(value: NewtypeField) -> FieldValues<RegisterField, Toggle>

Converts to this type from the input type.

impl From<NewtypeField> for FieldValues<RegisterField, Toggle>

fn from(value: NewtypeField) -> FieldValues<RegisterField, Toggle>

Converts to this type from the input type.

impl From<NewtypeImpl> for FieldValues<RegisterImpl, Toggle>

impl: only on impls

fn from(value: NewtypeImpl) -> FieldValues<RegisterImpl, Toggle>

Converts to this type from the input type.

impl From<NewtypeImpl> for FieldValues<RegisterImpl, Toggle>

impl: only on impls

fn from(value: NewtypeImpl) -> FieldValues<RegisterImpl, Toggle>

Converts to this type from the input type.

impl From<NewtypeType> for FieldValues<RegisterType, Toggle>

fn from(value: NewtypeType) -> FieldValues<RegisterType, Toggle>

Converts to this type from the input type.

impl From<NewtypeType> for FieldValues<RegisterType, Toggle>

fn from(value: NewtypeType) -> FieldValues<RegisterType, Toggle>

Converts to this type from the input type.

impl From<Small<Data>> for FieldValues<SmallRegister>

fn from(value: Small<Data>) -> FieldValues<SmallRegister>

Converts to this type from the input type.

impl From<Small<Mode>> for FieldValues<SmallRegister>

fn from(value: Small<Mode>) -> FieldValues<SmallRegister>

Converts to this type from the input type.

impl From<Small<State>> for FieldValues<SmallRegister, Toggle>

fn from(value: Small<State>) -> FieldValues<SmallRegister, Toggle>

Converts to this type from the input type.

impl From<Small<Status>> for FieldValues<SmallRegister, Toggle>

fn from(value: Small<Status>) -> FieldValues<SmallRegister, Toggle>

Converts to this type from the input type.

impl From<StatFlag> for FieldValues<STATUS, Toggle>

fn from(value: StatFlag) -> FieldValues<STATUS, Toggle>

Converts to this type from the input type.

impl From<State> for FieldValues<BigRegister, Toggle>

fn from(value: State) -> FieldValues<BigRegister, Toggle>

Converts to this type from the input type.

impl From<Status> for FieldValues<BigRegister, Toggle>

fn from(value: Status) -> FieldValues<BigRegister, Toggle>

Converts to this type from the input type.

impl From<Status> for FieldValues<STATUS>

fn from(value: Status) -> FieldValues<STATUS>

Converts to this type from the input type.

impl<R: RegisterValue, T: Into<FieldValues<R, Toggle>>> From<T> for FieldValues<R, ()>

fn from(bits: T) -> FieldValues<R, ()>

Converts to this type from the input type.

impl From<Type> for FieldValues<RegisterName>

fn from(value: Type) -> FieldValues<RegisterName>

Converts to this type from the input type.

impl<R: RegisterValue, T> MayToggle for FieldValues<R, T>

type Toggle = T

Toggle if it can be toggled, () otherwise

impl<R: RegisterValue> Not for FieldValues<R, Toggle>

type Output = FieldValues<R, Toggle>

The resulting type after applying the ! operator.

fn not(self) -> Self

Performs the unary ! operation.

impl<R: RegisterValue, T: Into<FieldValues<R>> + Copy, U> PartialEq<T> for FieldValues<R, U>

fn eq(&self, other: &T) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<R: RegisterValue, T> Copy for FieldValues<R, T>

impl<R: RegisterValue> Eq for FieldValues<R, ()>

impl<R: RegisterValue> Eq for FieldValues<R, Toggle>