Struct rust_debug::registers::Registers

pub struct Registers {
    pub registers: HashMap<u16, u32>,
    pub program_counter_register: Option<usize>,
    pub link_register: Option<usize>,
    pub stack_pointer_register: Option<usize>,
    pub cfa: Option<u32>,
    // some fields omitted
}

A struct to hold the register values and other register information.

Fields

registers: HashMap<u16, u32>

Holds all the register values.

program_counter_register: Option<usize>

The register number which is the program counter register.

link_register: Option<usize>

The register number which is the link register.

stack_pointer_register: Option<usize>

The register number which is the stack pointer register.

cfa: Option<u32>

Canonical Frame Address, which is sometimes needed to evaluate variables.

Implementations

impl Registers

pub fn new() -> Registers

Creates a empty Registers struct.

pub fn add_register_value(&mut self, register: u16, value: u32)

Add a register value to the struct.

Description:

• register - The register to add a value for.
• value - The value that will be stored for that registry.

This function will add the value to the self.registers HashMap with register as the hash number.

pub fn get_register_value(&self, register: &u16) -> Option<&u32>

Retrieve a register value.

Description:

• register - The register to get the value from.

Will retrieve the register value from the self.registers HashMap.

pub fn clear(&mut self)

Sets all the register values to None in the struct.

pub fn stash_registers(&mut self)

Temporally stash the current register values.

Description:

The current register values will be stashed allowing for other register values to be used in the evaluation of variables. This is only used when evaluating StackFrames because preserved register values need to be used in the evaluation.

pub fn pop_stashed_registers(&mut self)

Pop the stashed register values.

Description:

This is used to pop back the stashed registers into self.registers. This function is only called after doing a stack trace because preserved register values is used for evaluating the StackFrames.

Trait Implementations

impl Clone for Registers

fn clone(&self) -> Registers

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Registers

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

Formats the value using the given formatter.