Struct PrintDebugger 

pub struct PrintDebugger {
    pub source_map: SourceMap<String>,
    pub stack: bool,
    pub stack_bytes: bool,
    pub visit_stack: bool,
    pub registers: bool,
    pub registers_bytes: bool,
    pub visit_registers: bool,
    pub operation_details: bool,
    pub step_through: bool,
    pub mode: PrintDebuggerMode,
    /* private fields */
}

A debugger that prints every step to standard output.

Everything is off by default, so a bare PrintDebugger only announces the scopes and operations it passes. Turn the parts you want on with the builder methods, or start from PrintDebugger::full.

A value on the stack or in a register is only printed as a value when its type was registered with PrintDebugger::printable or one of its siblings. Anything else is printed as raw bytes.

Fields

source_map: SourceMap<String>

Names the printed places after the original source.

stack: bool

Print how many bytes the stack holds.

stack_bytes: bool

Print the raw bytes of the stack.

visit_stack: bool

Print each value on the stack, one by one.

registers: bool

Print the register count and the scope barriers.

registers_bytes: bool

Print the raw bytes of the register storage.

visit_registers: bool

Print each register, one by one.

operation_details: bool

Print the whole operation rather than only its name.

step_through: bool

Wait for a line on standard input after every printout.

mode: PrintDebuggerMode

When to print around an operation or a scope.

Implementations

impl PrintDebugger

pub fn full() -> PrintDebugger

A debugger with everything turned on, step_through included.

pub fn stack(self, mode: bool) -> PrintDebugger

Sets PrintDebugger::stack, builder style.

pub fn stack_bytes(self, mode: bool) -> PrintDebugger

Sets PrintDebugger::stack_bytes, builder style.

pub fn visit_stack(self, mode: bool) -> PrintDebugger

Sets PrintDebugger::visit_stack, builder style.

pub fn registers(self, mode: bool) -> PrintDebugger

Sets PrintDebugger::registers, builder style.

pub fn registers_bytes(self, mode: bool) -> PrintDebugger

Sets PrintDebugger::registers_bytes, builder style.

pub fn visit_registers(self, mode: bool) -> PrintDebugger

Sets PrintDebugger::visit_registers, builder style.

pub fn operation_details(self, mode: bool) -> PrintDebugger

Sets PrintDebugger::operation_details, builder style.

pub fn step_through(self, mode: bool) -> PrintDebugger

Sets PrintDebugger::step_through, builder style.

With it on, every printout waits for a line on standard input, so the script only moves when you press enter.

pub fn mode(self, mode: PrintDebuggerMode) -> PrintDebugger

Sets PrintDebugger::mode, builder style.

pub fn printable<T>(self) -> PrintDebugger

where T: Debug + 'static,

Prints values of type T with their Debug output.

pub fn printable_custom<T>( self, f: impl Fn(&PrintDebugger, &T) -> String + Send + Sync + 'static, ) -> PrintDebugger

where T: 'static,

Prints values of type T with a function of your own.

pub fn printable_raw<T>( self, f: impl Fn(&PrintDebugger, *const ()) -> String + Send + Sync + 'static, ) -> PrintDebugger

where T: 'static,

PrintDebugger::printable_custom with the value as a raw pointer.

For a type that cannot be named as a Rust reference here. The pointer given to f holds a value of T.

pub fn basic_printables(self) -> PrintDebugger

Registers the Rust primitives, char and String as printable.

pub fn display<T>(&self, data: &T) -> Option<(&'static str, String)>

Formats data with what was registered for its type.

Returns the type name and the text, or None when the type was never registered as printable.

pub fn display_raw( &self, type_hash: TypeHash, pointer: *const (), ) -> Option<(&'static str, String)>

PrintDebugger::display for a value whose type is only known at runtime.

pointer must hold a value of the type named by type_hash, which is what the caller has to get right.

Trait Implementations

impl Default for PrintDebugger

fn default() -> PrintDebugger

Returns the “default value” for a type.

impl<SE> VmDebugger<SE> for PrintDebugger

where SE: ScriptExpression + Debug,

fn on_enter_scope( &mut self, scope: &VmScope<'_, SE>, context: &mut Context, _: &Registry, )

Called once before the first operation of a scope.

fn on_exit_scope( &mut self, scope: &VmScope<'_, SE>, context: &mut Context, _: &Registry, )

Called when a step leaves the scope with nothing more to run, which is after its last operation or when an operation ends it early.

fn on_enter_operation( &mut self, scope: &VmScope<'_, SE>, operation: &ScriptOperation<'_, SE>, position: usize, context: &mut Context, _: &Registry, )

Called before each operation, with its index in the scope.

fn on_exit_operation( &mut self, scope: &VmScope<'_, SE>, operation: &ScriptOperation<'_, SE>, position: usize, context: &mut Context, _: &Registry, )

Called after each operation, with the index it ran at.

fn into_handle(self) -> Arc<RwLock<dyn VmDebugger<SE> + Send + Sync>>

where Self: Sized + Send + Sync + 'static,

Wraps this debugger in a shared handle a scope can take.