Skip to main content

DebugControl

Struct DebugControl 

Source
pub struct DebugControl { /* private fields */ }
Expand description

A controller used to manage breakpoints and execution flow for a running Axon.

This is typically stored in the Bus to allow the Axon runtime to check for pause-points between node executions.

Implementations§

Source§

impl DebugControl

Source

pub fn new() -> Self

Create a new DebugControl in the ‘Running’ state with no breakpoints.

Source

pub fn set_breakpoint(&self, node_id: String)

Add a breakpoint for a specific node ID.

Source

pub fn remove_breakpoint(&self, node_id: &str)

Remove a breakpoint for a specific node ID.

Source

pub fn pause(&self)

Request execution to pause at the next available node.

Source

pub fn resume(&self)

Resume execution from a paused state.

Source

pub fn step(&self)

Resume execution but pause again at the very next node.

Source

pub fn should_pause(&self, node_id: &str) -> bool

Check if the current node should trigger a pause.

This consumes the internal “pause_next” flag if it was set.

Source

pub async fn wait(&self)

Explicitly transition to Paused state and wait for a resume signal.

Source

pub async fn wait_if_needed(&self, node_id: &str)

Check if the current node requires a pause and wait if so.

Deprecated in favor of manual should_pause + wait for better event timing.

Source

pub fn state(&self) -> DebugState

Get the current debugger state.

Source

pub fn list_breakpoints(&self) -> Vec<String>

List all currently set breakpoint node IDs.

Trait Implementations§

Source§

impl Clone for DebugControl

Source§

fn clone(&self) -> DebugControl

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for DebugControl

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more