Struct DebuggerConfig 

pub struct DebuggerConfig {

    pub input: Option<InputFile>,
    pub inputs: Option<ExecutionConfig>,
    pub args: Vec<String>,
    pub working_dir: Option<PathBuf>,
    pub sysroot: Option<PathBuf>,
    pub color: ColorChoice,
    pub entrypoint: Option<String>,
    pub dap_connect: Option<String>,
    pub start_debug_adapter: Option<String>,
    pub source_path_prefixes: Vec<PathBuf>,
    pub replay: Option<PathBuf>,
    pub search_path: Vec<PathBuf>,
    pub link_libraries: Vec<LinkLibrary>,
    pub repl: bool,
    pub commands: Option<PathBuf>,
    pub profiler_cli_args: ProfilerCliArgs,
}

Run a compiled Miden package with the Miden VM

Fields

input: Option<InputFile>

Specify the path to a Miden package artifact to execute.

Miden Assembly packages are emitted by the compiler with a .masp extension.

You may use - as a file name to read a file from stdin.

inputs: Option<ExecutionConfig>

Specify the path to a file containing program inputs.

Program inputs are stack and advice provider values which the program can access during execution. The inputs file is a TOML file which describes what the inputs are, or where to source them from.

args: Vec<String>

Arguments to pass to the program entrypoint.

When the selected entrypoint has a component-model signature, arguments are encoded using its canonical ABI. This supports Rust values such as booleans and integers wider than a felt. Otherwise each argument is parsed as a raw field element and pushed in order.

NOTE: These arguments will override any stack values provided via –inputs

working_dir: Option<PathBuf>

The working directory for the debugger

By default this will be the working directory the debugger is executed from

sysroot: Option<PathBuf>

The path to the root directory of the current Miden toolchain

By default this is assumed to be `$(midenup show home)/toolchains/$(midenup show active-toolchain)

color: ColorChoice

Whether, and how, to color terminal output

entrypoint: Option<String>

Specify the function to call as the entrypoint for the program in the format <module_name>::<function>

dap_connect: Option<String>

Connect to a remote DAP debug server instead of running a local program.

Specify the address of the DAP server (e.g. “127.0.0.1:4711”). When this flag is set, the debugger connects to an existing remote session.

start_debug_adapter: Option<String>

Start a DAP debug server for the local program and wait for a client to connect.

Specify the address to listen on (e.g. “127.0.0.1:4711”).

source_path_prefixes: Vec<PathBuf>

Source path prefixes used by the compiler’s -Zremap-path-prefix option.

When debug info stores trimmed source paths, DAP clients may still send absolute editor paths. These prefixes provide an explicit mapping between the two forms.

replay: Option<PathBuf>

Replay a recorded execution snapshot in the TUI debugger.

FILE is a snapshot written during a recorded debug session (e.g. miden-client exec --start-debug-adapter <ADDR> --record <FILE>). The recorded program, inputs, resolved code, and event log are replayed so the same execution can be stepped through offline, without the original host.

search_path: Vec<PathBuf>

Specify one or more search paths for link libraries requested via -l

link_libraries: Vec<LinkLibrary>

Load the compiled library package NAME.

NAME must either be an absolute path (with extension when applicable), or a package namespace (no extension). The former will be used as the path to load the package, without looking for it in the library search paths, while the latter will be located in the search path.

KIND currently supports only masp (the default). The optional LINKAGE is either static or dynamic and defaults to dynamic.

repl: bool

Use the REPL (text-mode) debugger instead of the TUI

commands: Option<PathBuf>

Run a script of debugger commands non-interactively, then exit.

FILE is a list of debugger commands, one per line, using the same syntax as the interactive REPL prompt. Blank lines and lines beginning with # are ignored, so scripts may be commented. This is analogous to gdb -x <file> -batch or lldb -s <file>, and is primarily used to drive the debugger from lit/FileCheck tests.

profiler_cli_args: ProfilerCliArgs

Profiler configuration.

Implementations

impl DebuggerConfig

pub fn working_dir(&self) -> Cow<'_, Path>

pub fn toolchain_dir(&self) -> Option<PathBuf>

Trait Implementations

impl Args for DebuggerConfig

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Debug for DebuggerConfig

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

Formats the value using the given formatter.

impl Default for DebuggerConfig

fn default() -> DebuggerConfig

Returns the “default value” for a type.

impl FromArgMatches for DebuggerConfig

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.