Struct ClusterInfo

#[non_exhaustive]
pub struct ClusterInfo {
    pub name: String,
    pub description: Option<String>,
    pub alternate_cluster: 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

alternate_cluster: Option<String>

Specify the name of the original cluster if this cluster provides an alternative description

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 const fn single(self) -> Cluster

Construct single Cluster

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

Construct Cluster array

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

Construct single Cluster or array

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

Modify an existing ClusterInfo based on a builder.

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

Validate the ClusterInfo

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

Validate the ClusterInfo recursively

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

👎Deprecated since 0.12.1: Please use all_registers instead

Returns iterator over all descendant registers

pub fn all_registers(&self) -> AllRegistersIter<'_>

Returns iterator over all descendant registers

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

👎Deprecated since 0.12.1: Please use all_registers_mut instead

Returns mutable iterator over all descendant registers

pub fn all_registers_mut(&mut self) -> AllRegistersIterMut<'_>

Returns mutable iterator over all descendant registers

pub fn registers(&self) -> RegisterIter<'_>

Returns iterator over child registers

pub fn registers_mut(&mut self) -> RegisterIterMut<'_>

Returns mutable iterator over child registers

pub fn clusters(&self) -> ClusterIter<'_>

Returns iterator over child clusters

pub fn clusters_mut(&mut self) -> ClusterIterMut<'_>

Returns mutable iterator over child clusters

pub fn get_register(&self, name: &str) -> Option<&Register>

Get register by name

pub fn get_mut_register(&mut self, name: &str) -> Option<&mut Register>

Get mutable register by name

pub fn get_cluster(&self, name: &str) -> Option<&Cluster>

Get cluster by name

pub fn get_mut_cluster(&mut self, name: &str) -> Option<&mut Cluster>

Get mutable cluster by name

Trait Implementations

impl Clone for ClusterInfo

fn clone(&self) -> ClusterInfo

Returns a duplicate of the value.

const 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 Description for ClusterInfo

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

Get description

impl From<ClusterInfo> for ClusterInfoBuilder

fn from(c: ClusterInfo) -> Self

Converts to this type from the input type.

impl Name for ClusterInfo

fn name(&self) -> &str

Get name

impl PartialEq for ClusterInfo

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ClusterInfo