Struct DebugInfo 

pub struct DebugInfo { /* private fields */ }

Debug information for a MAST forest, containing decorators and error messages.

Implementations

impl DebugInfo

pub fn new() -> DebugInfo

Creates a new empty DebugInfo.

pub fn with_capacity( decorators_capacity: usize, nodes_capacity: usize, operations_capacity: usize, decorator_ids_capacity: usize, ) -> DebugInfo

Creates an empty DebugInfo with specified capacities.

pub fn empty_for_nodes(num_nodes: usize) -> DebugInfo

Creates an empty DebugInfo with valid CSR structures for N nodes.

pub fn is_empty(&self) -> bool

Returns true if this DebugInfo has no decorators, asm_ops, debug vars, error codes, or procedure names.

pub fn clear(&mut self)

Strips all debug information, removing decorators, asm_ops, debug vars, error codes, and procedure names.

This is used for release builds where debug info is not needed.

pub fn num_decorators(&self) -> usize

Returns the number of decorators.

pub fn decorators(&self) -> &[Decorator]

Returns all decorators as a slice.

pub fn decorator(&self, decorator_id: DecoratorId) -> Option<&Decorator>

Returns the decorator with the given ID, if it exists.

pub fn before_enter_decorators(&self, node_id: MastNodeId) -> &[DecoratorId]

Returns the before-enter decorators for the given node.

pub fn after_exit_decorators(&self, node_id: MastNodeId) -> &[DecoratorId]

Returns the after-exit decorators for the given node.

pub fn decorators_for_operation( &self, node_id: MastNodeId, local_op_idx: usize, ) -> &[DecoratorId]

Returns decorators for a specific operation within a node.

pub fn num_debug_vars(&self) -> usize

Returns the number of debug variables.

pub fn debug_vars(&self) -> &[DebugVarInfo]

Returns all debug variables as a slice.

pub fn debug_var(&self, debug_var_id: DebugVarId) -> Option<&DebugVarInfo>

Returns the debug variable with the given ID, if it exists.

pub fn debug_vars_for_node( &self, node_id: MastNodeId, ) -> Vec<(usize, DebugVarId)>

Returns all (op_idx, DebugVarId) pairs for the given node, or an empty vec if the node has no debug vars.

pub fn debug_vars_for_operation( &self, node_id: MastNodeId, local_op_idx: usize, ) -> &[DebugVarId]

Returns debug variable IDs for a specific operation within a node.

pub fn add_decorator( &mut self, decorator: Decorator, ) -> Result<DecoratorId, MastForestError>

Adds a decorator and returns its ID.

pub fn clear_mappings(&mut self)

Clears all decorator information while preserving error codes.

This is used when rebuilding decorator information from nodes.

pub fn num_asm_ops(&self) -> usize

Returns the number of AssemblyOps.

pub fn asm_ops(&self) -> &[AssemblyOp]

Returns all AssemblyOps as a slice.

pub fn asm_op(&self, asm_op_id: AsmOpId) -> Option<&AssemblyOp>

Returns the AssemblyOp with the given ID, if it exists.

pub fn asm_op_for_operation( &self, node_id: MastNodeId, op_idx: usize, ) -> Option<&AssemblyOp>

Returns the AssemblyOp for a specific operation within a node, if any.

pub fn first_asm_op_for_node(&self, node_id: MastNodeId) -> Option<&AssemblyOp>

Returns the first AssemblyOp for a node, if any.

pub fn asm_ops_for_node(&self, node_id: MastNodeId) -> Vec<(usize, AsmOpId)>

Returns all (op_idx, AsmOpId) pairs for the given node.

pub fn add_asm_op( &mut self, asm_op: AssemblyOp, ) -> Result<AsmOpId, MastForestError>

Adds an AssemblyOp and returns its ID.

pub fn rewrite_source_locations( &mut self, rewrite_location: impl FnMut(Location) -> Location, rewrite_file_line_col: impl FnMut(FileLineCol) -> FileLineCol, )

Rewrites the source-backed locations stored in this debug info.

pub fn register_asm_ops( &mut self, node_id: MastNodeId, num_operations: usize, asm_ops: Vec<(usize, AsmOpId)>, ) -> Result<(), AsmOpIndexError>

Registers operation-indexed AssemblyOps for a node.

The num_operations parameter must be the total number of operations in the node. This is needed to allocate enough space for all operations, even those without AssemblyOps, so that lookups at any valid operation index will work correctly.

pub fn add_debug_var( &mut self, debug_var: DebugVarInfo, ) -> Result<DebugVarId, MastForestError>

Adds a debug variable and returns its ID.

pub fn register_op_indexed_debug_vars( &mut self, node_id: MastNodeId, debug_vars_info: Vec<(usize, DebugVarId)>, ) -> Result<(), DecoratorIndexError>

Registers operation-indexed debug variables for a node.

This associates already-added debug variables with specific operations within a node.

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

Returns an error message by code.

pub fn error_codes(&self) -> impl Iterator<Item = (&u64, &Arc<str>)>

Returns an iterator over error codes.

pub fn insert_error_code(&mut self, code: u64, msg: Arc<str>)

Inserts an error code with its message.

pub fn extend_error_codes<I>(&mut self, error_codes: I)

where I: IntoIterator<Item = (u64, Arc<str>)>,

Inserts multiple error codes at once.

This is used when bulk error code insertion is needed.

pub fn clear_error_codes(&mut self)

Clears all error codes.

This is used when error code information needs to be reset.

pub fn procedure_name(&self, digest: &Word) -> Option<&str>

Returns the procedure name for the given MAST root digest, if present.

pub fn procedure_names(&self) -> impl Iterator<Item = (Word, &Arc<str>)>

Returns an iterator over all (digest, name) pairs.

pub fn num_procedure_names(&self) -> usize

Returns the number of procedure names.

pub fn insert_procedure_name(&mut self, digest: Word, name: Arc<str>)

Inserts a procedure name for the given MAST root digest.

pub fn extend_procedure_names<I>(&mut self, names: I)

where I: IntoIterator<Item = (Word, Arc<str>)>,

Inserts multiple procedure names at once.

pub fn clear_procedure_names(&mut self)

Clears all procedure names.

Trait Implementations

impl Clone for DebugInfo

fn clone(&self) -> DebugInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DebugInfo

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

Formats the value using the given formatter.

impl Default for DebugInfo

fn default() -> DebugInfo

Returns the “default value” for a type.

impl Deserializable for DebugInfo

fn read_from<R>(source: &mut R) -> Result<DebugInfo, DeserializationError>

where R: ByteReader,

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

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

Attempts to deserialize the provided bytes into Self and returns the result.

fn read_from_bytes_with_budget( bytes: &[u8], budget: usize, ) -> Result<Self, DeserializationError>

Deserializes Self from bytes with a byte budget limit.

impl<'de> Deserialize<'de> for DebugInfo

fn deserialize<__D>( __deserializer: __D, ) -> Result<DebugInfo, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DebugInfo

impl PartialEq for DebugInfo

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serializable for DebugInfo

fn write_into<W>(&self, target: &mut W)

where W: ByteWriter,

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Serialize for DebugInfo

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DebugInfo