Struct probe_rs::debug::registers::DebugRegister

pub struct DebugRegister {
    pub register_file: &'static RegisterFile,
    pub group: RegisterGroup,
    pub name: &'static str,
    pub special_name: Option<&'static str>,
    pub id: RegisterId,
    pub dwarf_id: Option<u16>,
    pub data_type: RegisterDataType,
    pub size_in_bits: usize,
    pub value: Option<RegisterValue>,
}

Stores the relevant information from RegisterDescription as well as additional information required during debug.

Fields

register_file: &'static RegisterFile

To lookup platform specific details of register definitions.

group: RegisterGroup

Register definitions are grouped depending on their purpose.

name: &'static str

The name of the register.

special_name: Option<&'static str>

If a special name exists for an existing register, e.g. Arm register ‘r15’ is also known as ‘pc’ (program counter)

id: RegisterId

The location where the register is stored.

dwarf_id: Option<u16>

DWARF specification, section 2.6.1.1.3.1 “… operations encode the names of up to 32 registers, numbered from 0 through 31, inclusive …”

data_type: RegisterDataType

The type of data stored in a register.

size_in_bits: usize

Size in bits, e.g. 32 or 64.

value: Option<RegisterValue>

The value of the register is read from the target memory and updated as needed.

Implementations

impl DebugRegister

pub fn get_register_name(&self) -> String

Retrieve the special name if it exists, else the actual name using the RegisterId as an identifier.

Trait Implementations

impl Clone for DebugRegister

fn clone(&self) -> DebugRegister

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DebugRegister

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

Formats the value using the given formatter.

impl PartialEq<DebugRegister> for DebugRegister

fn eq(&self, other: &DebugRegister) -> 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 StructuralPartialEq for DebugRegister