Struct svd_rs::clusterinfo::ClusterInfo

#[non_exhaustive]
pub struct ClusterInfo {
    pub name: String,
    pub description: Option<String>,
    pub header_struct_name: Option<String>,
    pub address_offset: u32,
    pub default_register_properties: RegisterProperties,
    pub children: Vec<RegisterCluster>,
    pub derived_from: Option<String>,
}

Description of a cluster

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 cluster. Cluster names are required to be unique within the scope of a peripheral

description: Option<String>

String describing the details of the register cluster

header_struct_name: Option<String>

Specify the struct type name created in the device header file

address_offset: u32

Cluster address relative to the baseAddress of the peripheral

default_register_properties: RegisterProperties

Default properties for all registers

children: Vec<RegisterCluster>

Children/members of the cluster

derived_from: Option<String>

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

Implementations

impl ClusterInfo

pub fn builder() -> ClusterInfoBuilder

Make a builder for ClusterInfo

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

Modify an existing ClusterInfo based on a builder.

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

Validate the ClusterInfo

impl ClusterInfo

pub fn reg_iter(&self) -> RegIter<'_>

returns a iterator over all registers the cluster contains

pub fn reg_iter_mut(&mut self) -> RegIterMut<'_>

returns a mutable iterator over all registers cluster contains

Trait Implementations

impl Clone for ClusterInfo

fn clone(&self) -> ClusterInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClusterInfo

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

Formats the value using the given formatter.

impl From<ClusterInfo> for ClusterInfoBuilder

fn from(c: ClusterInfo) -> Self

Performs the conversion.

impl PartialEq<ClusterInfo> for ClusterInfo

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

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

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

This method tests for !=.

impl StructuralPartialEq for ClusterInfo