Struct svd_rs::field::FieldInfo

#[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>,
}

A partition of a register

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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

impl FieldInfo

pub fn builder() -> FieldInfoBuilder

Make a builder for FieldInfo

pub const fn single(self) -> Field

Construct single Field

pub const fn array(self, dim: DimElement) -> Field

Construct Field array

pub fn maybe_array(self, dim: Option<DimElement>) -> Field

Construct single Field or array

pub fn modify_from( &mut self, builder: FieldInfoBuilder, lvl: ValidateLevel ) -> Result<(), SvdError>

Modify an existing FieldInfo based on a builder.

pub fn validate(&self, lvl: ValidateLevel) -> Result<(), SvdError>

Validate the FieldInfo.

pub fn validate_all(&self, lvl: ValidateLevel) -> Result<(), SvdError>

Validate the FieldInfo recursively

pub fn bit_offset(&self) -> u32

Get bit offset

pub fn bit_width(&self) -> u32

Get bit width

pub fn lsb(&self) -> u32

Get the position of the least significant bit

pub fn msb(&self) -> u32

Get the position of the most significant bit

pub fn get_enumerated_values(&self, usage: Usage) -> Option<&EnumeratedValues>

Get enumeratedValues cluster by usage

pub fn get_mut_enumerated_values( &mut self, usage: Usage ) -> Option<&mut EnumeratedValues>

Get mutable enumeratedValues by usage

Trait Implementations

impl Clone for FieldInfo

fn clone(&self) -> FieldInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FieldInfo

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

Formats the value using the given formatter.

impl Description for FieldInfo

fn description(&self) -> Option<&str>

Get description

impl From<FieldInfo> for FieldInfoBuilder

fn from(f: FieldInfo) -> Self

Converts to this type from the input type.

impl Name for FieldInfo

fn name(&self) -> &str

Get name

impl PartialEq for FieldInfo

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

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

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

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

impl Eq for FieldInfo

impl StructuralPartialEq for FieldInfo