Struct ContractDebugInfo 

pub struct ContractDebugInfo {
    pub address: Option<String>,
    pub name: String,
    pub info: EthdebugInfo,
    pub source_contents: BTreeMap<u64, String>,
    pub functions: Vec<SourceFunction>,
    pub storage_layout: Option<StorageLayout>,
    /* private fields */
}

One contract’s debug information, prepared for stepping: the ETHDebug metadata, the source text, the functions parsed from it, and the indexes that make per-step lookups constant time.

Fields

address: Option<String>

The deployed address this info describes, lowercase, when known.

name: String

info: EthdebugInfo

source_contents: BTreeMap<u64, String>

functions: Vec<SourceFunction>

storage_layout: Option<StorageLayout>

Where the contract’s state variables live, when it was compiled with --storage-layout.

Implementations

impl ContractDebugInfo

pub fn new( address: Option<&str>, name: &str, info: EthdebugInfo, source_contents: BTreeMap<u64, String>, ) -> Self

Prepares one contract’s debug info. Functions are parsed from the source text, which serves ETHDebug and legacy source maps alike: both attach byte ranges of the same sources to instructions.

pub fn with_storage_layout(self, storage_layout: Option<StorageLayout>) -> Self

Attaches the contract’s storage layout, so state variables can be read by name.

pub fn function_entry_at_pc(&self, pc: u64) -> Option<usize>

The function whose entry point pc is, when it is one.

pub fn is_jumpdest(&self, pc: u64) -> bool

Whether the instruction at pc is a JUMPDEST.

pub fn jump_marker_at_pc(&self, pc: u64) -> JumpMarker

What the artifact says about the jump the instruction at pc makes.

pub fn source_path(&self, source_id: u64) -> Option<&str>

pub fn line_of(&self, source_id: u64, offset: u64) -> Option<u64>

The one-based line a byte offset falls on, when the source text is available.

pub fn column_of(&self, source_id: u64, offset: u64) -> Option<u64>

pub fn line_count(&self, source_id: u64) -> Option<u64>

pub fn line_text(&self, source_id: u64, line: u64) -> Option<&str>

The text of one line, without its line ending.

pub fn location_at_pc(&self, pc: u64) -> Option<SourceLocation>

The source span the compiler attached to the instruction at pc.

pub fn instruction_at_pc(&self, pc: u64) -> Option<&Instruction>

The compiler’s instruction at pc, using the prepared index.

pub fn modifier_depth_at_pc(&self, pc: u64) -> Option<i64>

Legacy source-map modifier depth at pc, when the artifact carries it.

pub fn function_for_location(&self, location: &SourceLocation) -> Option<usize>

The narrowest parsed function whose declaration contains the span.

pub fn function_at_pc(&self, pc: u64) -> Option<&SourceFunction>

pub fn effective_line(&self, source_id: u64, line: u64) -> Option<u64>

The line a breakpoint on line of source_id resolves to: the line itself when the compiler generated code that begins there, otherwise the first line of the narrowest statement that contains it, or nothing when no code maps to the line.

Ranking matters because solc attaches the whole-contract span to the dispatcher, and that span intersects every line in the file.

Trait Implementations

impl Clone for ContractDebugInfo

fn clone(&self) -> ContractDebugInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContractDebugInfo

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

Formats the value using the given formatter.

impl Eq for ContractDebugInfo

impl PartialEq for ContractDebugInfo

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ContractDebugInfo