Struct svd_rs::cluster::ClusterInfo [−][src]
#[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>,
}
Expand description
Description of a cluster
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
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
Make a builder for ClusterInfo
Construct Cluster
array
pub fn modify_from(
&mut self,
builder: ClusterInfoBuilder,
lvl: ValidateLevel
) -> Result<(), SvdError>
pub fn modify_from(
&mut self,
builder: ClusterInfoBuilder,
lvl: ValidateLevel
) -> Result<(), SvdError>
Modify an existing ClusterInfo
based on a builder.
Validate the ClusterInfo
pub fn reg_iter(&self) -> AllRegistersIter<'_>ⓘNotable traits for AllRegistersIter<'a>impl<'a> Iterator for AllRegistersIter<'a> type Item = &'a Register;
👎 Deprecated since 0.12.1: Please use all_registers
instead
pub fn reg_iter(&self) -> AllRegistersIter<'_>ⓘNotable traits for AllRegistersIter<'a>impl<'a> Iterator for AllRegistersIter<'a> type Item = &'a Register;
impl<'a> Iterator for AllRegistersIter<'a> type Item = &'a Register;
Please use all_registers
instead
Returns iterator over all descendant registers
pub fn all_registers(&self) -> AllRegistersIter<'_>ⓘNotable traits for AllRegistersIter<'a>impl<'a> Iterator for AllRegistersIter<'a> type Item = &'a Register;
pub fn all_registers(&self) -> AllRegistersIter<'_>ⓘNotable traits for AllRegistersIter<'a>impl<'a> Iterator for AllRegistersIter<'a> type Item = &'a Register;
impl<'a> Iterator for AllRegistersIter<'a> type Item = &'a Register;
Returns iterator over all descendant registers
pub fn reg_iter_mut(&mut self) -> AllRegistersIterMut<'_>ⓘNotable traits for AllRegistersIterMut<'a>impl<'a> Iterator for AllRegistersIterMut<'a> type Item = &'a mut Register;
👎 Deprecated since 0.12.1: Please use all_registers_mut
instead
pub fn reg_iter_mut(&mut self) -> AllRegistersIterMut<'_>ⓘNotable traits for AllRegistersIterMut<'a>impl<'a> Iterator for AllRegistersIterMut<'a> type Item = &'a mut Register;
impl<'a> Iterator for AllRegistersIterMut<'a> type Item = &'a mut Register;
Please use all_registers_mut
instead
Returns mutable iterator over all descendant registers
pub fn all_registers_mut(&mut self) -> AllRegistersIterMut<'_>ⓘNotable traits for AllRegistersIterMut<'a>impl<'a> Iterator for AllRegistersIterMut<'a> type Item = &'a mut Register;
pub fn all_registers_mut(&mut self) -> AllRegistersIterMut<'_>ⓘNotable traits for AllRegistersIterMut<'a>impl<'a> Iterator for AllRegistersIterMut<'a> type Item = &'a mut Register;
impl<'a> Iterator for AllRegistersIterMut<'a> type Item = &'a mut Register;
Returns mutable iterator over all descendant registers
pub fn registers(&self) -> RegisterIter<'_>ⓘNotable traits for RegisterIter<'a>impl<'a> Iterator for RegisterIter<'a> type Item = &'a Register;
pub fn registers(&self) -> RegisterIter<'_>ⓘNotable traits for RegisterIter<'a>impl<'a> Iterator for RegisterIter<'a> type Item = &'a Register;
impl<'a> Iterator for RegisterIter<'a> type Item = &'a Register;
Returns iterator over child registers
pub fn registers_mut(&mut self) -> RegisterIterMut<'_>ⓘNotable traits for RegisterIterMut<'a>impl<'a> Iterator for RegisterIterMut<'a> type Item = &'a mut Register;
pub fn registers_mut(&mut self) -> RegisterIterMut<'_>ⓘNotable traits for RegisterIterMut<'a>impl<'a> Iterator for RegisterIterMut<'a> type Item = &'a mut Register;
impl<'a> Iterator for RegisterIterMut<'a> type Item = &'a mut Register;
Returns mutable iterator over child registers
pub fn clusters(&self) -> ClusterIter<'_>ⓘNotable traits for ClusterIter<'a>impl<'a> Iterator for ClusterIter<'a> type Item = &'a Cluster;
pub fn clusters(&self) -> ClusterIter<'_>ⓘNotable traits for ClusterIter<'a>impl<'a> Iterator for ClusterIter<'a> type Item = &'a Cluster;
impl<'a> Iterator for ClusterIter<'a> type Item = &'a Cluster;
Returns iterator over child clusters
pub fn clusters_mut(&mut self) -> ClusterIterMut<'_>ⓘNotable traits for ClusterIterMut<'a>impl<'a> Iterator for ClusterIterMut<'a> type Item = &'a mut Cluster;
pub fn clusters_mut(&mut self) -> ClusterIterMut<'_>ⓘNotable traits for ClusterIterMut<'a>impl<'a> Iterator for ClusterIterMut<'a> type Item = &'a mut Cluster;
impl<'a> Iterator for ClusterIterMut<'a> type Item = &'a mut Cluster;
Returns mutable iterator over child clusters
Get register by name
Get mutable register by name
Get cluster by name
Get mutable cluster by name
Trait Implementations
Performs the conversion.
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for ClusterInfo
impl Send for ClusterInfo
impl Sync for ClusterInfo
impl Unpin for ClusterInfo
impl UnwindSafe for ClusterInfo
Blanket Implementations
Mutably borrows from an owned value. Read more