Struct svd_expander::FieldSpec

pub struct FieldSpec {
    pub name: String,
    pub description: Option<String>,
    pub offset: u32,
    pub width: u32,
    pub access: Option<AccessSpec>,
    pub write_constraint: Option<WriteConstraintSpec>,
    pub modified_write_values: Option<ModifiedWriteValuesSpec>,
    pub enumerated_value_sets: Vec<EnumeratedValueSetSpec>,
    // some fields omitted
}

Describes a field on a register.

Fields

name: String

A name that identfies the field. Must be unique within the parent register.

description: Option<String>

Description of the field's usage, purpose, and/or operation.

offset: u32

The position of the least-significant bit of this field within its register.

width: u32

The bit width of the field.

access: Option<AccessSpec>

The access rights to the field.

write_constraint: Option<WriteConstraintSpec>

Constraints for writing values to the field.

modified_write_values: Option<ModifiedWriteValuesSpec>

Describes the manipulation of data written to this field. If None, the value written to the field is the value stored in the field.

enumerated_value_sets: Vec<EnumeratedValueSetSpec>

Implementations

impl FieldSpec

pub fn derived_from_path(&self) -> Option<String>

The full path to the field that this field inherits from (if any).

pub fn path(&self) -> String

The full path to this field.

Trait Implementations

impl Clone for FieldSpec

fn clone(&self) -> FieldSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FieldSpec

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

Formats the value using the given formatter.

impl PartialEq<FieldSpec> for FieldSpec

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

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

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

This method tests for !=.

impl StructuralPartialEq for FieldSpec