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, id: u32) -> Option<&Breakpoint>

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

pub fn get_mut(&mut self, id: u32) -> Option<&mut Breakpoint>

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

pub fn contains_key(&self, id: u32) -> bool

Checks if the ID 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) -> u32

Inserts a breakpoint into the list and returns its key.

This panics if another breakpoint is added while 2^32 breakpoints are currently active.

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

Remove breakpoint with a given ID.

If no breakpoint is present with this ID, 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) -> impl Iterator<Item = (u32, &Breakpoint)>

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

pub fn iter_mut(&mut self) -> impl Iterator<Item = (u32, &mut Breakpoint)>

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

pub fn keys(&self) -> impl Iterator<Item = u32> + '_

An iterator visiting all IDs in arbitrary order.

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

An iterator visiting all breakpoints in arbitrary order.

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

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

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<u32> for BreakpointList

type Output = Breakpoint

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<u32> for BreakpointList

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

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