Struct DebugInfo 

pub struct DebugInfo<Exec: Idx, Src: Idx> { /* private fields */ }

Represents debug information bound to a pending/finalized miden_core::mast::MastForest.

This includes all debug information needed for source-level debugging, and recovery of program state during execution (such as the types of local variables in the source program, and their location in memory or on the operand stack).

Implementations

impl DebugInfo<MastNodeId, DebugSourceNodeId>

pub fn read_from_unmetered<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>

Reads package debug information without the fixed resource limits enforced by Self::read_from.

Use this for data from a trusted producer or in analysis tooling where the caller accepts its memory and processing costs. This method still checks the wire format and honors the reader’s remaining input and allocation budget. Use Self::read_from for potentially adversarial input with the standard fixed limits.

pub fn read_from_bytes_unmetered( bytes: &[u8], ) -> Result<Self, DeserializationError>

Reads package debug information from bytes without the fixed resource limits enforced by Self::read_from_bytes.

Use this only when the caller accepts the memory and processing costs of the encoded data. The wire-format checks described by Self::read_from_unmetered still apply. Use Self::read_from_bytes for potentially adversarial input with the standard fixed limits.

impl<Exec: Idx, Src: Idx> DebugInfo<Exec, Src>

pub fn version(&self) -> u8

Get the version of this debug info instance

pub fn strings(&self) -> &IndexVec<DebugStringIdx, Arc<str>>

Get access to the strings table in this debug info

pub fn get_string(&self, idx: DebugStringIdx) -> Option<Arc<str>>

Gets a string by index.

pub fn files(&self) -> &IndexVec<DebugFileIdx, DebugFileInfo>

Get access to the files table in this debug info

pub fn get_file(&self, idx: DebugFileIdx) -> Option<&DebugFileInfo>

Gets a file by index.

pub fn get_file_index_by_uri(&self, uri: &Uri) -> Option<DebugFileIdx>

Gets the DebugFileIdx for a source file whose URI is uri, if it is recorded in the debug info built so far.

pub fn trim_file_paths(&mut self, trimmer: impl FnMut(&str) -> Option<Arc<str>>)

Apply trimmer to every distinct file path referenced by the file table.

If trimmer returns None, the file path is left unmodified. Otherwise, the returned path is interned and the corresponding file records are retargeted to it. Other debug records which reference the original string are left unchanged.

pub fn types(&self) -> &IndexVec<DebugTypeIdx, DebugTypeInfo>

Get access to the types table in this debug info

pub fn get_type(&self, idx: DebugTypeIdx) -> Option<&DebugTypeInfo>

Gets a type by index.

pub fn locations(&self) -> &IndexVec<DebugLocIdx, DebugLoc>

Get access to the locatinos table in this debug info

pub fn get_location(&self, idx: DebugLocIdx) -> Option<Location>

Returns the deduplicated source locations referenced by assembly operation rows.

pub fn error_messages(&self) -> &[DebugErrorMessage]

Get access to the error messages table in this debug info

pub fn error_message(&self, err_code: u64) -> Option<Arc<str>>

Returns the assertion error message for err_code, if present.

pub fn nodes(&self) -> &IndexVec<Src, SourceNode<Exec, Src>>

Returns source/debug occurrence nodes.

pub fn roots(&self) -> &[Src]

Returns source/debug occurrence roots.

pub fn source_node(&self, source_node: Src) -> Option<&SourceNode<Exec, Src>>

Returns a source/debug occurrence by ID.

pub fn functions(&self) -> &[FunctionInfo<Src>]

Get access to the functions table in this debug info

pub fn get_function(&self, idx: DebugFunctionIdx) -> Option<&FunctionInfo<Src>>

Gets the function info for idx

pub fn source_roots_for_exec_node( &self, exec_node: Exec, ) -> impl Iterator<Item = (Src, &SourceNode<Exec, Src>)>

Returns all source/debug roots that point at exec_node.

pub fn unique_source_root_for_exec_node( &self, exec_node: Exec, ) -> Result<Option<Src>, SourceGraphLookupError<Exec, Src>>

Returns the unique source/debug root that points at exec_node.

pub fn child_source_node( &self, parent: Src, child_index: usize, ) -> Result<Option<(Src, &SourceNode<Exec, Src>)>, SourceGraphLookupError<Exec, Src>>

Returns parent’s source/debug child at child_index, if present.

pub fn asm_ops_for_source_node( &self, source_node: Src, ) -> impl Iterator<Item = &DebugSourceAsmOp>

Returns assembly operation rows for a source/debug occurrence.

pub fn first_asm_op_for_source_node( &self, source_node: Src, ) -> Option<&DebugSourceAsmOp>

Returns the first assembly operation row for source_node, if present.

pub fn asm_op_for_operation( &self, source_node: Src, op_idx: u32, ) -> Option<&DebugSourceAsmOp>

Returns the assembly operation row for source_node at or before op_idx, if present.

pub fn debug_vars_for_source_node( &self, source_node: Src, ) -> impl Iterator<Item = &DebugSourceVar>

Returns debug variable rows for a source/debug occurrence.

pub fn debug_vars_for_operation( &self, source_node: Src, op_idx: u32, ) -> impl Iterator<Item = &DebugSourceVar>

Returns debug variable rows for source_node at op_idx.

pub fn inline_calls_for_source_node( &self, source_node: Src, ) -> impl Iterator<Item = &DebugSourceInlineCall>

Returns inline-call rows for a source/debug occurrence.

pub fn inline_calls_for_operation( &self, source_node: Src, op_idx: u32, ) -> impl Iterator<Item = &DebugSourceInlineCall>

Returns inline-call rows for source_node at op_idx.

impl<Exec: Idx, Src: Idx> DebugInfo<Exec, Src>

pub fn merge_tables_into<TargetExec: Idx, TargetSrc: Idx>( &self, target: &mut DebugInfoBuilder<TargetExec, TargetSrc>, ) -> Result<DebugInfoTableRemapping, DebugInfoTableRemapError>

Imports the shared string, type, file, location, and error-message tables into target.

The returned map translates every source table index to its destination index. Type rows are reserved as a complete batch before their payloads are rewritten, which preserves forward and cyclic references. Functions are imported with their source-node associations cleared; callers which also import source nodes must restore those associations after establishing the source-node mapping.

impl<Src: SourceNodeIdMarker> DebugInfo<MastNodeId, Src>

pub fn merge_source_debug<'a>( inputs: impl IntoIterator<Item = (usize, &'a Self)>, root_map: &MastForestRootMap, ) -> Result<Self, DebugInfoMergeError<MastNodeId, Src>>

where Src: 'a,

Merges package-owned source/debug metadata after a miden_core::mast::MastForest merge.

miden_core::mast::MastForest::merge remains execution-only. This helper applies the returned node mappings to package source/debug sections so callers can merge (MastForest, PackageDebugInfo) pairs without reattaching debug metadata to the forest.

This also merges the type, source-file, and function tables referenced by source-map inline-call rows.

Trait Implementations

impl<Exec, Src> Clone for DebugInfo<Exec, Src>

where Exec: Idx + Clone, Src: Idx + Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Exec, Src> Debug for DebugInfo<Exec, Src>

where Exec: Idx + Debug, Src: Idx + Debug,

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

Formats the value using the given formatter.

impl<Exec: Idx, Src: Idx> Default for DebugInfo<Exec, Src>

fn default() -> Self

Returns the “default value” for a type.

impl<Exec: Eq + Idx, Src: Eq + Idx> Eq for DebugInfo<Exec, Src>

impl<Exec: Idx, Src: Idx> From<Box<DebugInfo<Exec, Src>>> for DebugInfoBuilder<Exec, Src>

fn from(debug_info: Box<DebugInfo<Exec, Src>>) -> Self

Converts to this type from the input type.

impl<Exec: Idx, Src: Idx> Index<DebugFileIdx> for DebugInfo<Exec, Src>

type Output = DebugFileInfo

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<Exec: Idx, Src: Idx> Index<DebugFunctionIdx> for DebugInfo<Exec, Src>

type Output = FunctionInfo<Src>

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<Exec: Idx, Src: Idx> Index<DebugLocIdx> for DebugInfo<Exec, Src>

type Output = DebugLoc

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<Exec: Idx, Src: Idx> Index<DebugStringIdx> for DebugInfo<Exec, Src>

type Output = Arc<str>

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<Exec: Idx, Src: Idx> Index<DebugTypeIdx> for DebugInfo<Exec, Src>

type Output = DebugTypeInfo

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<Exec: Idx, Src: SourceNodeIdMarker> Index<Src> for DebugInfo<Exec, Src>

type Output = SourceNode<Exec, Src>

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<Exec: PartialEq + Idx, Src: PartialEq + Idx> PartialEq for DebugInfo<Exec, Src>

fn eq(&self, other: &DebugInfo<Exec, Src>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<Exec: PartialEq + Idx, Src: PartialEq + Idx> StructuralPartialEq for DebugInfo<Exec, Src>