Struct FrameStack

pub struct FrameStack { /* private fields */ }

The stack of call frames.

This struct is used within the Simulator to keep track of the frames of subroutine/trap calls. The amount of information it keeps track of depends on the debug_frames flag of the Simulator.

• If the debug_frames flag is true, this keeps track of a Vec of Frames, which contains a large set of information about each frame.
• If the debug_frames flag is false, this only keeps track of the number of frames traversed.

Implementations

impl FrameStack

pub fn get_trap_def(&self, vect: u8) -> Option<&ParameterList>

Gets the parameter definition for a trap (if it is defined).

pub fn get_subroutine_def(&self, addr: u16) -> Option<&ParameterList>

Gets the parameter definition for a subroutine (if it is defined).

Note that the simulator does not automatically make subroutine definitions. Subroutine definitions have to be manually set by the FrameStack::set_subroutine_def method.

pub fn set_subroutine_def(&mut self, addr: u16, params: ParameterList)

Sets the parameter definition for a subroutine.

This will overwrite any preexisting definition for a given subroutine.

pub fn len(&self) -> u64

Gets the current number of frames entered.

pub fn is_empty(&self) -> bool

Tests whether the frame stack is at top level execution.

pub fn frames(&self) -> Option<&[Frame]>

Gets the list of current frames (if debug frames are enabled).

Trait Implementations

impl Debug for FrameStack

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

Formats the value using the given formatter.

impl Default for FrameStack

fn default() -> Self

Returns the “default value” for a type.