Struct lc3_ensemble::sim::debug::BreakpointList

pub struct BreakpointList { /* private fields */ }

A list of breakpoints.

This works similarly to GDB breakpoints, in that creating a breakpoint gives you an ID which you can use to query or remove the breakpoint later.

Implementations

impl BreakpointList

pub fn new() -> Self

Creates a new breakpoint list.

pub fn get(&self, key: BreakpointKey) -> Option<&Breakpoint>

Gets an immutable reference to breakpoint with a given key, returning None if it was already removed.

pub fn get_mut(&mut self, key: BreakpointKey) -> Option<&mut Breakpoint>

Gets a mutable reference to breakpoint with a given key, returning None if it was already removed.

pub fn contains_key(&self, key: BreakpointKey) -> bool

Checks if the key is currently associated with some breakpoint.

pub fn len(&self) -> usize

Counts the number of defined breakpoints.

pub fn is_empty(&self) -> bool

Checks if the breakpoint list is empty.

pub fn insert(&mut self, bpt: Breakpoint) -> BreakpointKey

Inserts a breakpoint into the list and returns its key.

pub fn remove(&mut self, key: BreakpointKey) -> Option<Breakpoint>

Remove breakpoint with given key.

If breakpoint was previously removed, then this returns None.

pub fn remove_breakpoint( &mut self, breakpoint: &Breakpoint ) -> Option<Breakpoint>

Remove breakpoint that matches a given value.

This is a utility function to remove a breakpoint by value. If you’d like to remove by key, use BreakpointList::remove.

Note that this can only reliably remove PC, Reg, and Mem breakpoints. The remaining 3 may fail to match even if an identical breakpoint appears in the list.

pub fn remove_breakpoint_by( &mut self, pred: impl FnMut(&mut Breakpoint) -> bool ) -> Option<Breakpoint>

Remove breakpoint that matches a given predicate.

This is a utility function to remove a breakpoint by value. If you’d like to remove by key, use BreakpointList::remove.

pub fn clear(&mut self)

Removes all breakpoints from the list.

pub fn iter(&self) -> Iter<'_, BreakpointKey, Breakpoint>

An iterator visiting all breakpoints and their associated keys in arbitrary order.

This function must iterate over all slots, empty or not. In the face of many deleted elements it can be inefficient.

pub fn iter_mut(&mut self) -> IterMut<'_, BreakpointKey, Breakpoint>

An iterator visiting all breakpoints and their associated keys in arbitrary order, with a mutable reference to each breakpoint.

This function must iterate over all slots, empty or not. In the face of many deleted elements it can be inefficient.

pub fn keys(&self) -> Keys<'_, BreakpointKey, Breakpoint>

An iterator visiting all keys in arbitrary order.

This function must iterate over all slots, empty or not. In the face of many deleted elements it can be inefficient.

pub fn values(&self) -> Values<'_, BreakpointKey, Breakpoint>

An iterator visiting all breakpoints in arbitrary order.

This function must iterate over all slots, empty or not. In the face of many deleted elements it can be inefficient.

pub fn values_mut(&mut self) -> ValuesMut<'_, BreakpointKey, Breakpoint>

An iterator visiting all breakpoints in arbitrary order, with a mutable reference to each breakpoint.

This function must iterate over all slots, empty or not. In the face of many deleted elements it can be inefficient.

Trait Implementations

impl Debug for BreakpointList

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

Formats the value using the given formatter.

impl Default for BreakpointList

fn default() -> BreakpointList

Returns the “default value” for a type.

impl Index<BreakpointKey> for BreakpointList

type Output = Breakpoint

The returned type after indexing.

fn index(&self, index: BreakpointKey) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<BreakpointKey> for BreakpointList

fn index_mut(&mut self, index: BreakpointKey) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.