Struct svd_rs::enumeratedvalue::EnumeratedValue

#[non_exhaustive]
pub struct EnumeratedValue {
    pub name: String,
    pub description: Option<String>,
    pub value: Option<u64>,
    pub is_default: Option<bool>,
}

Describes a single entry in the enumeration.

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 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

impl EnumeratedValue

pub fn is_default(&self) -> bool

Enumerated value is defaulted for non-explicit values

pub fn builder() -> EnumeratedValueBuilder

Make a builder for EnumeratedValue

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

Modify an existing EnumeratedValue based on a builder.

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

Validate the EnumeratedValue.

Trait Implementations

impl Clone for EnumeratedValue

fn clone(&self) -> EnumeratedValue

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EnumeratedValue

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Description for EnumeratedValue

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

Get description

impl From<EnumeratedValue> for EnumeratedValueBuilder

fn from(e: EnumeratedValue) -> Self

Converts to this type from the input type.

impl Name for EnumeratedValue

fn name(&self) -> &str

Get name

impl PartialEq for EnumeratedValue

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for EnumeratedValue

impl StructuralPartialEq for EnumeratedValue