Struct svd_rs::register::RegisterInfo

#[non_exhaustive]
pub struct RegisterInfo {
    pub name: String,
    pub display_name: Option<String>,
    pub description: Option<String>,
    pub alternate_group: Option<String>,
    pub alternate_register: Option<String>,
    pub address_offset: u32,
    pub properties: RegisterProperties,
    pub modified_write_values: Option<ModifiedWriteValues>,
    pub write_constraint: Option<WriteConstraint>,
    pub read_action: Option<ReadAction>,
    pub fields: Option<Vec<Field>>,
    pub derived_from: Option<String>,
}

A register is a named, programmable resource that belongs to a peripheral.

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

String to identify the register. Register names are required to be unique within the scope of a peripheral

display_name: Option<String>

Specifies a register name without the restrictions of an ANSI C identifier.

description: Option<String>

String describing the details of the register

alternate_group: Option<String>

Specifies a group name associated with all alternate register that have the same name

alternate_register: Option<String>

This tag can reference a register that has been defined above to current location in the description and that describes the memory location already

address_offset: u32

Define the address offset relative to the enclosing element

properties: RegisterProperties

Specifies register size, access permission and reset value

modified_write_values: Option<ModifiedWriteValues>

Specifies the write side effects

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 register is not modified

fields: Option<Vec<Field>>

None indicates that the <fields> node is not present

derived_from: Option<String>

Specify the register name from which to inherit data. Elements specified subsequently override inherited values

Implementations

impl RegisterInfo

pub fn builder() -> RegisterInfoBuilder

Make a builder for RegisterInfo

pub const fn single(self) -> Register

Construct single Register

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

Construct Register array

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

Modify an existing RegisterInfo based on a builder.

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

Validate the RegisterInfo

pub fn fields(&self) -> Iter<'_, Field>

Returns iterator over child fields

pub fn fields_mut(&mut self) -> IterMut<'_, Field>

Returns mutable iterator over child fields

pub fn get_field(&self, name: &str) -> Option<&Field>

Get field by name

pub fn get_mut_field(&mut self, name: &str) -> Option<&mut Field>

Get mutable field by name

Trait Implementations

impl Clone for RegisterInfo

fn clone(&self) -> RegisterInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegisterInfo

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

Formats the value using the given formatter.

impl From<RegisterInfo> for RegisterInfoBuilder

fn from(r: RegisterInfo) -> Self

Converts to this type from the input type.

impl Name for RegisterInfo

fn name(&self) -> &str

Get name

impl PartialEq<RegisterInfo> for RegisterInfo

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

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

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

This method tests for !=.

impl StructuralPartialEq for RegisterInfo