Struct drone_svd::Field

[+] Show declaration

[+] Expand attributes
#[non_exhaustive]pub struct Field {
    pub dim: Option<u32>,
    pub dim_increment: Option<u32>,
    pub name: String,
    pub description: String,
    pub bit_offset: Option<u32>,
    pub bit_width: Option<u32>,
    pub lsb: Option<u32>,
    pub msb: Option<u32>,
    pub access: Option<Access>,
}

[−] Expand description

Bit-field properties of a register.

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.

dim: Option<u32>

[−] Expand description

Define the number of elements in an array.

dim_increment: Option<u32>

[−] Expand description

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

name: String

[−] Expand description

Name string used to identify the field.

description: String

[−] Expand description

String describing the details of the register.

bit_offset: Option<u32>

[−] Expand description

The position of the least significant bit of the field within the register.

bit_width: Option<u32>

[−] Expand description

The bit-width of the bitfield within the register.

lsb: Option<u32>

[−] Expand description

The bit position of the least significant bit within the register.

msb: Option<u32>

[−] Expand description

The bit position of the most significant bit within the register.

access: Option<Access>

[−] Expand description

The access type.

Implementations

impl Field[−]

pub fn bit_offset(&self) -> u32[−]

Returns the position of the least significant bit of the field within the register.

pub fn bit_width(&self) -> u32[−]

Returns the bit-width of the bitfield within the register.

Trait Implementations

impl Clone for Field[+]

[+] Show hidden undocumented items

fn clone(&self) -> Field[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for Field[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Default for Field[+]

[+] Show hidden undocumented items

fn default() -> Field[−]

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Field[+]

[+] Show hidden undocumented items

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<Field> for Field[+]

[+] Show hidden undocumented items

fn eq(&self, other: &Field) -> bool[−]

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

fn ne(&self, other: &Field) -> bool[−]

This method tests for !=.

impl StructuralPartialEq for Field