Struct drone_svd::Register

#[non_exhaustive]
pub struct Register {
    pub dim: Option<u32>,
    pub dim_increment: Option<u32>,
    pub name: String,
    pub description: String,
    pub address_offset: u32,
    pub size: Option<u32>,
    pub access: Option<Access>,
    pub reset_value: Option<u32>,
    // some fields omitted
}

The description of a register.

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.

dim: Option<u32>

Define the number of elements in an array.

dim_increment: Option<u32>

Specify the address increment, in Bytes, between two neighboring array members in the address map.

name: String

String to identify the register.

description: String

String describing the details of the register.

address_offset: u32

The address offset relative to the enclosing element.

size: Option<u32>

The bit-width of the register.

access: Option<Access>

The access rights for the register.

reset_value: Option<u32>

The default value for the register at RESET.

Methods

impl Register

pub fn field(&mut self, name: &str) -> &mut Field

Returns a mutable reference to the field with name name.

pub fn add_field(&mut self, field: Field)

Adds a new field field.

pub fn new_field(&mut self, f: impl FnOnce(&mut Field))

Adds a new field initialized by f.

pub fn remove_field(&mut self, name: &str) -> Field

Removes the field with name name.

Trait Implementations

impl Clone for Register

fn clone(&self) -> Register

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Register

fn default() -> Register

Returns the "default value" for a type.

impl Debug for Register

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Register

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.