Struct svd_rs::field::FieldInfo [−][src]
#[non_exhaustive]pub struct FieldInfo {
pub name: String,
pub description: Option<String>,
pub bit_range: BitRange,
pub access: Option<Access>,
pub modified_write_values: Option<ModifiedWriteValues>,
pub write_constraint: Option<WriteConstraint>,
pub read_action: Option<ReadAction>,
pub enumerated_values: Vec<EnumeratedValues>,
pub derived_from: Option<String>,
}
Expand description
A partition of a register
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.name: String
Name string used to identify the field. Field names must be unique within a register
description: Option<String>
String describing the details of the register
bit_range: BitRange
Bit position of the field within the register
access: Option<Access>
Predefined strings set the access type. The element can be omitted if access rights get inherited from parent elements
modified_write_values: Option<ModifiedWriteValues>
Describe the manipulation of data written to a field.
write_constraint: Option<WriteConstraint>
Specifies the subset of allowed write values
read_action: Option<ReadAction>
If set, it specifies the side effect following a read operation. If not set, the field is not modified
enumerated_values: Vec<EnumeratedValues>
Describes the field
derived_from: Option<String>
Specify the field name from which to inherit data. Elements specified subsequently override inherited values
Implementations
Make a builder for FieldInfo
Construct Field
array
pub fn modify_from(
&mut self,
builder: FieldInfoBuilder,
lvl: ValidateLevel
) -> Result<(), SvdError>
pub fn modify_from(
&mut self,
builder: FieldInfoBuilder,
lvl: ValidateLevel
) -> Result<(), SvdError>
Get bit offset
Get enumeratedValues cluster by usage
Get mutable enumeratedValues by usage
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for FieldInfo
impl UnwindSafe for FieldInfo
Blanket Implementations
Mutably borrows from an owned value. Read more