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 theperiph!
,register!
orfield_type!
macros. Reg::fields
orValue
&
Fields
: read some fields from the register.Default
orFieldValues::empty
: no fields’ values.
Used with:
Reg::modify
orValue
|
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]
impl<R: RegisterValue, T> FieldValues<R, T>
[src]pub unsafe fn from_raw(bits: R::Int, mask: R::Int) -> FieldValues<R, T>
[src]
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]
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]
impl<R: RegisterValue, T: Into<Fields<R>>, U> BitAnd<T> for FieldValues<R, U> where
T: Either<U>,
[src]impl<R: RegisterValue, T: Into<Fields<R>>, U> BitAndAssign<T> for FieldValues<R, U> where
T: Either<U, Output = U>,
[src]
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]
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]
impl<R: RegisterValue, T: Into<FieldValues<R>>, U> BitOr<T> for FieldValues<R, U> where
T: Both<U>,
[src]impl<R: RegisterValue, T: Into<FieldValues<R>>, U> BitOrAssign<T> for FieldValues<R, U> where
T: Both<U, Output = U>,
[src]
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]
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]
impl<R: RegisterValue, T: Into<Fields<R>>, U> BitXor<T> for FieldValues<R, U> where
T: Either<U, Output = Toggle>,
[src]impl<R: RegisterValue, T: Into<Fields<R>>, U> BitXorAssign<T> for FieldValues<R, U> where
T: Either<U, Output = Toggle>,
[src]
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]
fn bitxor_assign(&mut self, other: T)
[src]Performs the ^=
operation. Read more
impl<R: RegisterValue, T> Clone for FieldValues<R, T>
[src]
impl<R: RegisterValue, T> Clone for FieldValues<R, T>
[src]fn clone(&self) -> 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]
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]
impl<R: RegisterValue, T> Debug for FieldValues<R, T>
[src]impl<R: RegisterValue, T> Default for FieldValues<R, T>
[src]
impl<R: RegisterValue, T> Default for FieldValues<R, T>
[src]fn default() -> FieldValues<R, T>
[src]
fn default() -> FieldValues<R, T>
[src]Returns the “default value” for a type. Read more
impl From<Data> for FieldValues<BigRegister>
[src]
impl From<Data> for FieldValues<BigRegister>
[src]fn from(value: Data) -> FieldValues<BigRegister>
[src]
fn from(value: Data) -> FieldValues<BigRegister>
[src]Performs the conversion.
impl From<Data> for FieldValues<BUFFER>
[src]
impl From<Data> for FieldValues<BUFFER>
[src]fn from(value: Data) -> FieldValues<BUFFER>
[src]
fn from(value: Data) -> FieldValues<BUFFER>
[src]Performs the conversion.
impl From<Enum> for FieldValues<Register>
[src]
impl From<Enum> for FieldValues<Register>
[src]fn from(value: Enum) -> FieldValues<Register>
[src]
fn from(value: Enum) -> FieldValues<Register>
[src]Performs the conversion.
impl From<Enum> for FieldValues<Register>
[src]
impl From<Enum> for FieldValues<Register>
[src]fn from(value: Enum) -> FieldValues<Register>
[src]
fn from(value: Enum) -> FieldValues<Register>
[src]Performs the conversion.
impl From<Enum> for FieldValues<RegisterName>
[src]
impl From<Enum> for FieldValues<RegisterName>
[src]fn from(value: Enum) -> FieldValues<RegisterName>
[src]
fn from(value: Enum) -> FieldValues<RegisterName>
[src]Performs the conversion.
impl From<EnumAll> for FieldValues<RegisterAll>
[src]
impl From<EnumAll> for FieldValues<RegisterAll>
[src]all
: on everything
fn from(value: EnumAll) -> FieldValues<RegisterAll>
[src]
fn from(value: EnumAll) -> FieldValues<RegisterAll>
[src]Performs the conversion.
impl From<EnumAll> for FieldValues<RegisterAll>
[src]
impl From<EnumAll> for FieldValues<RegisterAll>
[src]all
: on everything
fn from(value: EnumAll) -> FieldValues<RegisterAll>
[src]
fn from(value: EnumAll) -> FieldValues<RegisterAll>
[src]Performs the conversion.
impl From<EnumField> for FieldValues<RegisterField>
[src]
impl From<EnumField> for FieldValues<RegisterField>
[src]fn from(value: EnumField) -> FieldValues<RegisterField>
[src]
fn from(value: EnumField) -> FieldValues<RegisterField>
[src]Performs the conversion.
impl From<EnumField> for FieldValues<RegisterField>
[src]
impl From<EnumField> for FieldValues<RegisterField>
[src]fn from(value: EnumField) -> FieldValues<RegisterField>
[src]
fn from(value: EnumField) -> FieldValues<RegisterField>
[src]Performs the conversion.
impl From<EnumImpl> for FieldValues<RegisterImpl>
[src]
impl From<EnumImpl> for FieldValues<RegisterImpl>
[src]impl
: only on impls
fn from(value: EnumImpl) -> FieldValues<RegisterImpl>
[src]
fn from(value: EnumImpl) -> FieldValues<RegisterImpl>
[src]Performs the conversion.
impl From<EnumImpl> for FieldValues<RegisterImpl>
[src]
impl From<EnumImpl> for FieldValues<RegisterImpl>
[src]impl
: only on impls
fn from(value: EnumImpl) -> FieldValues<RegisterImpl>
[src]
fn from(value: EnumImpl) -> FieldValues<RegisterImpl>
[src]Performs the conversion.
impl From<EnumType> for FieldValues<RegisterType>
[src]
impl From<EnumType> for FieldValues<RegisterType>
[src]fn from(value: EnumType) -> FieldValues<RegisterType>
[src]
fn from(value: EnumType) -> FieldValues<RegisterType>
[src]Performs the conversion.
impl From<EnumType> for FieldValues<RegisterType>
[src]
impl From<EnumType> for FieldValues<RegisterType>
[src]fn from(value: EnumType) -> FieldValues<RegisterType>
[src]
fn from(value: EnumType) -> FieldValues<RegisterType>
[src]Performs the conversion.
impl From<Extern> for FieldValues<Register>
[src]
impl From<Extern> for FieldValues<Register>
[src]fn from(value: Extern) -> FieldValues<Register>
[src]
fn from(value: Extern) -> FieldValues<Register>
[src]Performs the conversion.
impl From<ExternAll> for FieldValues<RegisterAll>
[src]
impl From<ExternAll> for FieldValues<RegisterAll>
[src]all
: on everything
fn from(value: ExternAll) -> FieldValues<RegisterAll>
[src]
fn from(value: ExternAll) -> FieldValues<RegisterAll>
[src]Performs the conversion.
impl From<ExternField> for FieldValues<RegisterField>
[src]
impl From<ExternField> for FieldValues<RegisterField>
[src]fn from(value: ExternField) -> FieldValues<RegisterField>
[src]
fn from(value: ExternField) -> FieldValues<RegisterField>
[src]Performs the conversion.
impl From<ExternImpl> for FieldValues<RegisterImpl>
[src]
impl From<ExternImpl> for FieldValues<RegisterImpl>
[src]impl
: only on impls
fn from(value: ExternImpl) -> FieldValues<RegisterImpl>
[src]
fn from(value: ExternImpl) -> FieldValues<RegisterImpl>
[src]Performs the conversion.
impl From<ExternType> for FieldValues<RegisterType>
[src]
impl From<ExternType> for FieldValues<RegisterType>
[src]fn from(value: ExternType) -> FieldValues<RegisterType>
[src]
fn from(value: ExternType) -> FieldValues<RegisterType>
[src]Performs the conversion.
impl From<Mode> for FieldValues<BigRegister>
[src]
impl From<Mode> for FieldValues<BigRegister>
[src]fn from(value: Mode) -> FieldValues<BigRegister>
[src]
fn from(value: Mode) -> FieldValues<BigRegister>
[src]Performs the conversion.
impl From<Mode> for FieldValues<CONFIG>
[src]
impl From<Mode> for FieldValues<CONFIG>
[src]fn from(value: Mode) -> FieldValues<CONFIG>
[src]
fn from(value: Mode) -> FieldValues<CONFIG>
[src]Performs the conversion.
impl From<Newtype> for FieldValues<RegisterName, Toggle>
[src]
impl From<Newtype> for FieldValues<RegisterName, Toggle>
[src]fn from(value: Newtype) -> FieldValues<RegisterName, Toggle>
[src]
fn from(value: Newtype) -> FieldValues<RegisterName, Toggle>
[src]Performs the conversion.
impl From<NewtypeAll> for FieldValues<RegisterAll, Toggle>
[src]
impl From<NewtypeAll> for FieldValues<RegisterAll, Toggle>
[src]all
: on everything
fn from(value: NewtypeAll) -> FieldValues<RegisterAll, Toggle>
[src]
fn from(value: NewtypeAll) -> FieldValues<RegisterAll, Toggle>
[src]Performs the conversion.
impl From<NewtypeAll> for FieldValues<RegisterAll, Toggle>
[src]
impl From<NewtypeAll> for FieldValues<RegisterAll, Toggle>
[src]all
: on everything
fn from(value: NewtypeAll) -> FieldValues<RegisterAll, Toggle>
[src]
fn from(value: NewtypeAll) -> FieldValues<RegisterAll, Toggle>
[src]Performs the conversion.
impl From<NewtypeField> for FieldValues<RegisterField, Toggle>
[src]
impl From<NewtypeField> for FieldValues<RegisterField, Toggle>
[src]fn from(value: NewtypeField) -> FieldValues<RegisterField, Toggle>
[src]
fn from(value: NewtypeField) -> FieldValues<RegisterField, Toggle>
[src]Performs the conversion.
impl From<NewtypeField> for FieldValues<RegisterField, Toggle>
[src]
impl From<NewtypeField> for FieldValues<RegisterField, Toggle>
[src]fn from(value: NewtypeField) -> FieldValues<RegisterField, Toggle>
[src]
fn from(value: NewtypeField) -> FieldValues<RegisterField, Toggle>
[src]Performs the conversion.
impl From<NewtypeImpl> for FieldValues<RegisterImpl, Toggle>
[src]
impl From<NewtypeImpl> for FieldValues<RegisterImpl, Toggle>
[src]impl
: only on impls
fn from(value: NewtypeImpl) -> FieldValues<RegisterImpl, Toggle>
[src]
fn from(value: NewtypeImpl) -> FieldValues<RegisterImpl, Toggle>
[src]Performs the conversion.
impl From<NewtypeImpl> for FieldValues<RegisterImpl, Toggle>
[src]
impl From<NewtypeImpl> for FieldValues<RegisterImpl, Toggle>
[src]impl
: only on impls
fn from(value: NewtypeImpl) -> FieldValues<RegisterImpl, Toggle>
[src]
fn from(value: NewtypeImpl) -> FieldValues<RegisterImpl, Toggle>
[src]Performs the conversion.
impl From<NewtypeType> for FieldValues<RegisterType, Toggle>
[src]
impl From<NewtypeType> for FieldValues<RegisterType, Toggle>
[src]fn from(value: NewtypeType) -> FieldValues<RegisterType, Toggle>
[src]
fn from(value: NewtypeType) -> FieldValues<RegisterType, Toggle>
[src]Performs the conversion.
impl From<NewtypeType> for FieldValues<RegisterType, Toggle>
[src]
impl From<NewtypeType> for FieldValues<RegisterType, Toggle>
[src]fn from(value: NewtypeType) -> FieldValues<RegisterType, Toggle>
[src]
fn from(value: NewtypeType) -> FieldValues<RegisterType, Toggle>
[src]Performs the conversion.
impl From<Small<Data>> for FieldValues<SmallRegister>
[src]
impl From<Small<Data>> for FieldValues<SmallRegister>
[src]fn from(value: Small<Data>) -> FieldValues<SmallRegister>
[src]
fn from(value: Small<Data>) -> FieldValues<SmallRegister>
[src]Performs the conversion.
impl From<Small<Mode>> for FieldValues<SmallRegister>
[src]
impl From<Small<Mode>> for FieldValues<SmallRegister>
[src]fn from(value: Small<Mode>) -> FieldValues<SmallRegister>
[src]
fn from(value: Small<Mode>) -> FieldValues<SmallRegister>
[src]Performs the conversion.
impl From<Small<State>> for FieldValues<SmallRegister, Toggle>
[src]
impl From<Small<State>> for FieldValues<SmallRegister, Toggle>
[src]fn from(value: Small<State>) -> 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]
impl From<Small<Status>> for FieldValues<SmallRegister, Toggle>
[src]fn from(value: Small<Status>) -> FieldValues<SmallRegister, Toggle>
[src]
fn from(value: Small<Status>) -> FieldValues<SmallRegister, Toggle>
[src]Performs the conversion.
impl From<State> for FieldValues<BigRegister, Toggle>
[src]
impl From<State> for FieldValues<BigRegister, Toggle>
[src]fn from(value: State) -> FieldValues<BigRegister, Toggle>
[src]
fn from(value: State) -> FieldValues<BigRegister, Toggle>
[src]Performs the conversion.
impl From<Status> for FieldValues<BigRegister, Toggle>
[src]
impl From<Status> for FieldValues<BigRegister, Toggle>
[src]fn from(value: Status) -> FieldValues<BigRegister, Toggle>
[src]
fn from(value: Status) -> FieldValues<BigRegister, Toggle>
[src]Performs the conversion.
impl From<Status> for FieldValues<STATUS>
[src]
impl From<Status> for FieldValues<STATUS>
[src]fn from(value: Status) -> 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]
impl<R: RegisterValue, T: Into<FieldValues<R, Toggle>>> From<T> for FieldValues<R, ()>
[src]fn from(bits: T) -> FieldValues<R, ()>
[src]
fn from(bits: T) -> FieldValues<R, ()>
[src]Performs the conversion.
impl From<Type> for FieldValues<RegisterName>
[src]
impl From<Type> for FieldValues<RegisterName>
[src]fn from(value: Type) -> FieldValues<RegisterName>
[src]
fn from(value: Type) -> FieldValues<RegisterName>
[src]Performs the conversion.
impl<R: RegisterValue, T> MayToggle for FieldValues<R, T>
[src]
impl<R: RegisterValue, T> MayToggle for FieldValues<R, T>
[src]type Toggle = T
type Toggle = T
Toggle
if it can be toggled, ()
otherwise
impl<R: RegisterValue> Not for FieldValues<R, Toggle>
[src]
impl<R: RegisterValue> Not for FieldValues<R, Toggle>
[src]impl<R: RegisterValue, T: Into<FieldValues<R>> + Copy, U> PartialEq<T> for FieldValues<R, U>
[src]
impl<R: RegisterValue, T: Into<FieldValues<R>> + Copy, U> PartialEq<T> for FieldValues<R, U>
[src]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,
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,
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,
R: Unpin,
T: Unpin,
<R as RegisterValue>::Int: Unpin,