Struct svd_rs::enumeratedvalue::EnumeratedValue
source · [−]#[non_exhaustive]pub struct EnumeratedValue {
pub name: String,
pub description: Option<String>,
pub value: Option<u64>,
pub is_default: Option<bool>,
}
Expand description
Describes a single entry in the enumeration.
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 describing the semantics of the value. Can be displayed instead of the value
description: Option<String>
Extended string describing the value
value: Option<u64>
Defines the constant for the bit-field as decimal, hexadecimal or binary number
is_default: Option<bool>
Defines the name and description for all other values that are not listed explicitly
Implementations
sourceimpl EnumeratedValue
impl EnumeratedValue
sourcepub fn builder() -> EnumeratedValueBuilder
pub fn builder() -> EnumeratedValueBuilder
Make a builder for EnumeratedValue
sourcepub fn modify_from(
&mut self,
builder: EnumeratedValueBuilder,
lvl: ValidateLevel
) -> Result<(), SvdError>
pub fn modify_from(
&mut self,
builder: EnumeratedValueBuilder,
lvl: ValidateLevel
) -> Result<(), SvdError>
Modify an existing EnumeratedValue
based on a builder.
sourcepub fn validate(&mut self, lvl: ValidateLevel) -> Result<(), SvdError>
pub fn validate(&mut self, lvl: ValidateLevel) -> Result<(), SvdError>
Validate the EnumeratedValue
.
Trait Implementations
sourceimpl Clone for EnumeratedValue
impl Clone for EnumeratedValue
sourcefn clone(&self) -> EnumeratedValue
fn clone(&self) -> EnumeratedValue
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 EnumeratedValue
impl Debug for EnumeratedValue
sourceimpl From<EnumeratedValue> for EnumeratedValueBuilder
impl From<EnumeratedValue> for EnumeratedValueBuilder
sourcefn from(e: EnumeratedValue) -> Self
fn from(e: EnumeratedValue) -> Self
Converts to this type from the input type.
sourceimpl PartialEq<EnumeratedValue> for EnumeratedValue
impl PartialEq<EnumeratedValue> for EnumeratedValue
sourcefn eq(&self, other: &EnumeratedValue) -> bool
fn eq(&self, other: &EnumeratedValue) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &EnumeratedValue) -> bool
fn ne(&self, other: &EnumeratedValue) -> bool
This method tests for !=
.
impl StructuralPartialEq for EnumeratedValue
Auto Trait Implementations
impl RefUnwindSafe for EnumeratedValue
impl Send for EnumeratedValue
impl Sync for EnumeratedValue
impl Unpin for EnumeratedValue
impl UnwindSafe for EnumeratedValue
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