Struct svd_rs::cluster::ClusterInfo
source · [−]#[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: StringString 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: u32Cluster address relative to the baseAddress of the peripheral
default_register_properties: RegisterPropertiesDefault 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
sourceimpl ClusterInfo
impl ClusterInfo
sourcepub fn builder() -> ClusterInfoBuilder
pub fn builder() -> ClusterInfoBuilder
Make a builder for ClusterInfo
sourcepub const fn array(self, dim: DimElement) -> Cluster
pub const fn array(self, dim: DimElement) -> Cluster
Construct Cluster array
sourcepub 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.
sourcepub fn validate(&mut self, lvl: ValidateLevel) -> Result<(), SvdError>
pub fn validate(&mut self, lvl: ValidateLevel) -> Result<(), SvdError>
Validate the ClusterInfo
sourcepub 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;
Please use all_registers instead
Returns iterator over all descendant registers
sourcepub 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;
Returns iterator over all descendant registers
sourcepub 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;
Please use all_registers_mut instead
Returns mutable iterator over all descendant registers
sourcepub 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;
Returns mutable iterator over all descendant registers
sourcepub 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;
Returns iterator over child registers
sourcepub 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;
Returns mutable iterator over child registers
sourcepub 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;
Returns iterator over child clusters
sourcepub 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;
Returns mutable iterator over child clusters
sourcepub fn get_register(&self, name: &str) -> Option<&Register>
pub fn get_register(&self, name: &str) -> Option<&Register>
Get register by name
sourcepub fn get_mut_register(&mut self, name: &str) -> Option<&mut Register>
pub fn get_mut_register(&mut self, name: &str) -> Option<&mut Register>
Get mutable register by name
sourcepub fn get_cluster(&self, name: &str) -> Option<&Cluster>
pub fn get_cluster(&self, name: &str) -> Option<&Cluster>
Get cluster by name
sourcepub fn get_mut_cluster(&mut self, name: &str) -> Option<&mut Cluster>
pub fn get_mut_cluster(&mut self, name: &str) -> Option<&mut Cluster>
Get mutable cluster by name
Trait Implementations
sourceimpl Clone for ClusterInfo
impl Clone for ClusterInfo
sourcefn clone(&self) -> ClusterInfo
fn clone(&self) -> ClusterInfo
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
sourceimpl Debug for ClusterInfo
impl Debug for ClusterInfo
sourceimpl From<ClusterInfo> for ClusterInfoBuilder
impl From<ClusterInfo> for ClusterInfoBuilder
sourcefn from(c: ClusterInfo) -> Self
fn from(c: ClusterInfo) -> Self
Converts to this type from the input type.
sourceimpl PartialEq<ClusterInfo> for ClusterInfo
impl PartialEq<ClusterInfo> for ClusterInfo
sourcefn eq(&self, other: &ClusterInfo) -> bool
fn eq(&self, other: &ClusterInfo) -> bool
This method tests for self and other values to be equal, and is used
by ==. Read more
sourcefn ne(&self, other: &ClusterInfo) -> bool
fn ne(&self, other: &ClusterInfo) -> bool
This method tests for !=.
impl StructuralPartialEq for ClusterInfo
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more