Struct peripherals::FieldValues[−][src]

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

Expand description

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>`[src]

`pub fn bits(self) -> R::Int`[src]

Get the raw bits to set

`pub fn mask(self) -> R::Int`[src]

Get the raw mask

`pub fn fields(self) -> Fields<R, T>`[src]

Get the fields specified in this value

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

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>`[src]

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

Trait Implementations

`impl<R: RegisterValue, T: Into<Fields<R>>, U> BitAnd<T> for FieldValues<R, U> where T: Either<U>,` [src]

`type Output = FieldValues<R, T::Output>`

The resulting type after applying the & operator.

`fn bitand(self, other: T) -> Self::Output`[src]

Performs the & operation. Read more

`impl<R: RegisterValue, T: Into<Fields<R>>, U> BitAndAssign<T> for FieldValues<R, U> where T: Either<U, Output = U>,` [src]

`fn bitand_assign(&mut self, other: T)`[src]

Performs the &= operation. Read more

`impl<R: RegisterValue, T: Into<FieldValues<R>>, U> BitOr<T> for FieldValues<R, U> where T: Both<U>,` [src]

`type Output = FieldValues<R, T::Output>`

The resulting type after applying the | operator.

`fn bitor(self, other: T) -> Self::Output`[src]

Performs the | operation. Read more

`impl<R: RegisterValue, T: Into<FieldValues<R>>, U> BitOrAssign<T> for FieldValues<R, U> where T: Both<U, Output = U>,` [src]

`fn bitor_assign(&mut self, other: T)`[src]

Performs the |= operation. Read more

`impl<R: RegisterValue, T: Into<Fields<R>>, U> BitXor<T> for FieldValues<R, U> where T: Either<U, Output = Toggle>,` [src]

`type Output = FieldValues<R, U>`

The resulting type after applying the ^ operator.

`fn bitxor(self, other: T) -> Self::Output`[src]

Performs the ^ operation. Read more

`impl<R: RegisterValue, T: Into<Fields<R>>, U> BitXorAssign<T> for FieldValues<R, U> where T: Either<U, Output = Toggle>,` [src]

`fn bitxor_assign(&mut self, other: T)`[src]

Performs the ^= operation. Read more

`impl<R: RegisterValue, T> Clone for FieldValues<R, T>`[src]

`fn clone(&self) -> FieldValues<R, T>`[src]

Returns a copy of the value. Read more

`fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from source. Read more

`impl<R: RegisterValue, T> Debug for FieldValues<R, T>`[src]

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

Formats the value using the given formatter. Read more

`impl<R: RegisterValue, T> Default for FieldValues<R, T>`[src]

`fn default() -> FieldValues<R, T>`[src]

Returns the “default value” for a type. Read more

`impl From<CfgFlag> for FieldValues<CONFIG, Toggle>`[src]

`fn from(value: CfgFlag) -> FieldValues<CONFIG, Toggle>`[src]

Performs the conversion.

`impl From<Data> for FieldValues<BigRegister>`[src]

`fn from(value: Data) -> FieldValues<BigRegister>`[src]

Performs the conversion.

`impl From<Data> for FieldValues<BUFFER>`[src]

`fn from(value: Data) -> FieldValues<BUFFER>`[src]

Performs the conversion.

`impl From<Enum> for FieldValues<Register>`[src]

`fn from(value: Enum) -> FieldValues<Register>`[src]

Performs the conversion.

`impl From<Enum> for FieldValues<Register>`[src]

`fn from(value: Enum) -> FieldValues<Register>`[src]

Performs the conversion.

`impl From<Enum> for FieldValues<RegisterName>`[src]

`fn from(value: Enum) -> FieldValues<RegisterName>`[src]

Performs the conversion.

`impl From<EnumAll> for FieldValues<RegisterAll>`[src]

all: on everything

`fn from(value: EnumAll) -> FieldValues<RegisterAll>`[src]

Performs the conversion.

`impl From<EnumAll> for FieldValues<RegisterAll>`[src]

all: on everything

`fn from(value: EnumAll) -> FieldValues<RegisterAll>`[src]

Performs the conversion.

`impl From<EnumField> for FieldValues<RegisterField>`[src]

`fn from(value: EnumField) -> FieldValues<RegisterField>`[src]

Performs the conversion.

`impl From<EnumField> for FieldValues<RegisterField>`[src]

`fn from(value: EnumField) -> FieldValues<RegisterField>`[src]

Performs the conversion.

`impl From<EnumImpl> for FieldValues<RegisterImpl>`[src]

impl: only on impls

`fn from(value: EnumImpl) -> FieldValues<RegisterImpl>`[src]

Performs the conversion.

`impl From<EnumImpl> for FieldValues<RegisterImpl>`[src]

impl: only on impls

`fn from(value: EnumImpl) -> FieldValues<RegisterImpl>`[src]

Performs the conversion.

`impl From<EnumType> for FieldValues<RegisterType>`[src]

`fn from(value: EnumType) -> FieldValues<RegisterType>`[src]

Performs the conversion.

`impl From<EnumType> for FieldValues<RegisterType>`[src]

`fn from(value: EnumType) -> FieldValues<RegisterType>`[src]

Performs the conversion.

`impl From<Extern> for FieldValues<Register>`[src]

`fn from(value: Extern) -> FieldValues<Register>`[src]

Performs the conversion.

`impl From<ExternAll> for FieldValues<RegisterAll>`[src]

all: on everything

`fn from(value: ExternAll) -> FieldValues<RegisterAll>`[src]

Performs the conversion.

`impl From<ExternField> for FieldValues<RegisterField>`[src]

`fn from(value: ExternField) -> FieldValues<RegisterField>`[src]

Performs the conversion.

`impl From<ExternImpl> for FieldValues<RegisterImpl>`[src]

impl: only on impls

`fn from(value: ExternImpl) -> FieldValues<RegisterImpl>`[src]

Performs the conversion.

`impl From<ExternType> for FieldValues<RegisterType>`[src]

`fn from(value: ExternType) -> FieldValues<RegisterType>`[src]

Performs the conversion.

`impl From<Mode> for FieldValues<BigRegister>`[src]

`fn from(value: Mode) -> FieldValues<BigRegister>`[src]

Performs the conversion.

`impl From<Mode> for FieldValues<CONFIG>`[src]

`fn from(value: Mode) -> FieldValues<CONFIG>`[src]

Performs the conversion.

`impl From<Newtype> for FieldValues<Register, Toggle>`[src]

`fn from(value: Newtype) -> FieldValues<Register, Toggle>`[src]

Performs the conversion.

`impl From<Newtype> for FieldValues<Register, Toggle>`[src]

`fn from(value: Newtype) -> FieldValues<Register, Toggle>`[src]

Performs the conversion.

`impl From<Newtype> for FieldValues<RegisterName, Toggle>`[src]

`fn from(value: Newtype) -> FieldValues<RegisterName, Toggle>`[src]

Performs the conversion.

`impl From<NewtypeAll> for FieldValues<RegisterAll, Toggle>`[src]

all: on everything

`fn from(value: NewtypeAll) -> FieldValues<RegisterAll, Toggle>`[src]

Performs the conversion.

`impl From<NewtypeAll> for FieldValues<RegisterAll, Toggle>`[src]

all: on everything

`fn from(value: NewtypeAll) -> FieldValues<RegisterAll, Toggle>`[src]

Performs the conversion.

`impl From<NewtypeField> for FieldValues<RegisterField, Toggle>`[src]

`fn from(value: NewtypeField) -> FieldValues<RegisterField, Toggle>`[src]

Performs the conversion.

`impl From<NewtypeField> for FieldValues<RegisterField, Toggle>`[src]

`fn from(value: NewtypeField) -> FieldValues<RegisterField, Toggle>`[src]

Performs the conversion.

`impl From<NewtypeImpl> for FieldValues<RegisterImpl, Toggle>`[src]

impl: only on impls

`fn from(value: NewtypeImpl) -> FieldValues<RegisterImpl, Toggle>`[src]

Performs the conversion.

`impl From<NewtypeImpl> for FieldValues<RegisterImpl, Toggle>`[src]

impl: only on impls

`fn from(value: NewtypeImpl) -> FieldValues<RegisterImpl, Toggle>`[src]

Performs the conversion.

`impl From<NewtypeType> for FieldValues<RegisterType, Toggle>`[src]

`fn from(value: NewtypeType) -> FieldValues<RegisterType, Toggle>`[src]

Performs the conversion.

`impl From<NewtypeType> for FieldValues<RegisterType, Toggle>`[src]

`fn from(value: NewtypeType) -> FieldValues<RegisterType, Toggle>`[src]

Performs the conversion.

`impl From<Small<Data>> for FieldValues<SmallRegister>`[src]

`fn from(value: Small<Data>) -> FieldValues<SmallRegister>`[src]

Performs the conversion.

`impl From<Small<Mode>> for FieldValues<SmallRegister>`[src]

`fn from(value: Small<Mode>) -> FieldValues<SmallRegister>`[src]

Performs the conversion.

`impl From<Small<State>> for FieldValues<SmallRegister, Toggle>`[src]

`fn from(value: Small<State>) -> FieldValues<SmallRegister, Toggle>`[src]

Performs the conversion.

`impl From<Small<Status>> for FieldValues<SmallRegister, Toggle>`[src]

`fn from(value: Small<Status>) -> FieldValues<SmallRegister, Toggle>`[src]

Performs the conversion.

`impl From<StatFlag> for FieldValues<STATUS, Toggle>`[src]

`fn from(value: StatFlag) -> FieldValues<STATUS, Toggle>`[src]

Performs the conversion.

`impl From<State> for FieldValues<BigRegister, Toggle>`[src]

`fn from(value: State) -> FieldValues<BigRegister, Toggle>`[src]

Performs the conversion.

`impl From<Status> for FieldValues<BigRegister, Toggle>`[src]

`fn from(value: Status) -> FieldValues<BigRegister, Toggle>`[src]

Performs the conversion.

`impl From<Status> for FieldValues<STATUS>`[src]

`fn from(value: Status) -> FieldValues<STATUS>`[src]

Performs the conversion.

`impl<R: RegisterValue, T: Into<FieldValues<R, Toggle>>> From<T> for FieldValues<R, ()>`[src]

`fn from(bits: T) -> FieldValues<R, ()>`[src]

Performs the conversion.

`impl From<Type> for FieldValues<RegisterName>`[src]

`fn from(value: Type) -> FieldValues<RegisterName>`[src]

Performs the conversion.

`impl<R: RegisterValue, T> MayToggle for FieldValues<R, T>`[src]

`type Toggle = T`

Toggle if it can be toggled, () otherwise

`impl<R: RegisterValue> Not for FieldValues<R, Toggle>`[src]

`type Output = Self`

The resulting type after applying the ! operator.

`fn not(self) -> Self`[src]

Performs the unary ! operation. Read more

`impl<R: RegisterValue, T: Into<FieldValues<R>> + Copy, U> PartialEq<T> for FieldValues<R, U>`[src]

`fn eq(&self, other: &T) -> bool`[src]

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

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

This method tests for !=.

`impl<R: RegisterValue, T> Copy for FieldValues<R, T>`[src]

`impl<R: RegisterValue> Eq for FieldValues<R, ()>`[src]

`impl<R: RegisterValue> Eq for FieldValues<R, Toggle>`[src]

Auto Trait Implementations

`impl<R, T> Send for FieldValues<R, T> where R: Send, T: Send, <R as RegisterValue>::Int: Send,`

`impl<R, T> Sync for FieldValues<R, T> where R: Sync, T: Sync, <R as RegisterValue>::Int: Sync,`

`impl<R, T> Unpin for FieldValues<R, T> where R: Unpin, T: Unpin, <R as RegisterValue>::Int: Unpin,`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

Gets the TypeId of self. Read more

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

Performs the conversion.

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

Performs the conversion.

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

`pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.