Struct svd_rs::enumeratedvalues::EnumeratedValues
source · #[non_exhaustive]pub struct EnumeratedValues {
pub name: Option<String>,
pub usage: Option<Usage>,
pub derived_from: Option<String>,
pub values: Vec<EnumeratedValue>,
}
Expand description
A map describing unsigned integers and their description and name.
Fields (Non-exhaustive)§
This struct is marked as 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: Option<String>
Identifier for the whole enumeration section
usage: Option<Usage>
Usage of the values
derived_from: Option<String>
Makes a copy from a previously defined enumeratedValues section. No modifications are allowed
values: Vec<EnumeratedValue>
List of variants. The number of required items depends on the bit-width of the associated field.
Implementations§
source§impl EnumeratedValues
impl EnumeratedValues
sourcepub fn default_value(&self) -> Option<&EnumeratedValue>
pub fn default_value(&self) -> Option<&EnumeratedValue>
Return default value if present
sourcepub fn builder() -> EnumeratedValuesBuilder
pub fn builder() -> EnumeratedValuesBuilder
Make a builder for EnumeratedValues
sourcepub fn modify_from(
&mut self,
builder: EnumeratedValuesBuilder,
lvl: ValidateLevel
) -> Result<(), SvdError>
pub fn modify_from( &mut self, builder: EnumeratedValuesBuilder, lvl: ValidateLevel ) -> Result<(), SvdError>
Modify an existing EnumeratedValues
based on a builder.
sourcepub fn validate(&self, lvl: ValidateLevel) -> Result<(), SvdError>
pub fn validate(&self, lvl: ValidateLevel) -> Result<(), SvdError>
Validate the EnumeratedValues
sourcepub fn validate_all(&self, lvl: ValidateLevel) -> Result<(), SvdError>
pub fn validate_all(&self, lvl: ValidateLevel) -> Result<(), SvdError>
Validate the EnumeratedValues
recursively.
sourcepub fn get_value(&self, name: &str) -> Option<&EnumeratedValue>
pub fn get_value(&self, name: &str) -> Option<&EnumeratedValue>
Get enumeratedValue
by name
sourcepub fn get_mut_value(&mut self, name: &str) -> Option<&mut EnumeratedValue>
pub fn get_mut_value(&mut self, name: &str) -> Option<&mut EnumeratedValue>
Get mutable enumeratedValue
by name
Trait Implementations§
source§impl Clone for EnumeratedValues
impl Clone for EnumeratedValues
source§fn clone(&self) -> EnumeratedValues
fn clone(&self) -> EnumeratedValues
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for EnumeratedValues
impl Debug for EnumeratedValues
source§impl From<EnumeratedValues> for EnumeratedValuesBuilder
impl From<EnumeratedValues> for EnumeratedValuesBuilder
source§fn from(e: EnumeratedValues) -> Self
fn from(e: EnumeratedValues) -> Self
Converts to this type from the input type.
source§impl PartialEq for EnumeratedValues
impl PartialEq for EnumeratedValues
source§fn eq(&self, other: &EnumeratedValues) -> bool
fn eq(&self, other: &EnumeratedValues) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.impl Eq for EnumeratedValues
impl StructuralEq for EnumeratedValues
impl StructuralPartialEq for EnumeratedValues
Auto Trait Implementations§
impl RefUnwindSafe for EnumeratedValues
impl Send for EnumeratedValues
impl Sync for EnumeratedValues
impl Unpin for EnumeratedValues
impl UnwindSafe for EnumeratedValues
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more