Skip to main content

DebugAction

tui_dispatch::debug

Enum DebugAction 

Source 
pub enum DebugAction {

Show 21 variants    Toggle,
    CopyFrame,
    ToggleState,
    ToggleActionLog,
    ToggleComponents,
    ToggleMouseCapture,
    InspectCell {
        column: u16,
        row: u16,
    },
    CloseOverlay,
    RequestCapture,
    ActionLogScrollUp,
    ActionLogScrollDown,
    ActionLogScrollTop,
    ActionLogScrollBottom,
    ActionLogPageUp,
    ActionLogPageDown,
    ActionLogShowDetail,
    ActionLogBackToList,
    StateTreeShowDetail,
    StateTreeBackToTree,
    ComponentShowDetail,
    ComponentBackToList,

}
Expand description

Debug actions provided by tui-dispatch

These are framework-level debug actions that apps can map from their own action types via keybindings.

Variants§

§

Toggle

Toggle debug freeze mode on/off

§

CopyFrame

Copy frozen frame to clipboard

§

ToggleState

Toggle state overlay

§

ToggleActionLog

Toggle action log overlay

§

ToggleComponents

Toggle components overlay

§

ToggleMouseCapture

Toggle mouse capture mode for cell inspection

§

InspectCell

Inspect cell at position (from mouse click)

Fields

§column: u16
§row: u16
§

CloseOverlay

Close current overlay

§

RequestCapture

Request a new frame capture

§

ActionLogScrollUp

Scroll action log up

§

ActionLogScrollDown

Scroll action log down

§

ActionLogScrollTop

Scroll action log to top

§

ActionLogScrollBottom

Scroll action log to bottom

§

ActionLogPageUp

Page up in action log

§

ActionLogPageDown

Page down in action log

§

ActionLogShowDetail

Show detail for selected action

§

ActionLogBackToList

Go back from detail view to action log

§

StateTreeShowDetail

Show detail for selected state tree entry

§

StateTreeBackToTree

Go back from state detail to state tree

§

ComponentShowDetail

Show detail for selected component

§

ComponentBackToList

Go back from component detail to components list

Implementations§

Source§

impl DebugAction

Source

pub const CMD_TOGGLE: &'static str = "debug.toggle"

Standard command names for keybinding lookup

Source

pub const CMD_COPY_FRAME: &'static str = "debug.copy"

Source

pub const CMD_TOGGLE_STATE: &'static str = "debug.state"

Source

pub const CMD_TOGGLE_ACTION_LOG: &'static str = "debug.action_log"

Source

pub const CMD_TOGGLE_COMPONENTS: &'static str = "debug.components"

Source

pub const CMD_TOGGLE_MOUSE: &'static str = "debug.mouse"

Source

pub const CMD_CLOSE_OVERLAY: &'static str = "debug.close"

Source

pub fn from_command(cmd: &str) -> Option<DebugAction>

Try to parse a command string into a debug action

Source

pub fn command(&self) -> Option<&'static str>

Get the command string for this action

Trait Implementations§

Source§

impl Clone for DebugAction

Source§

fn clone(&self) -> DebugAction

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DebugAction

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for DebugAction

Source§

impl PartialEq for DebugAction

Source§

fn eq(&self, other: &DebugAction) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DebugAction

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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