Expand description
Typed Rust bindings for an embedded Ghidra JVM.
This crate owns the Ghidra bridge and exposes lifecycle handles plus typed program, listing, decompiler, and metadata models. It deliberately stops at Ghidra primitives - higher-level extraction or schema mapping belongs in consumer crates.
Structs§
- Address
- Program address with address-space, numeric offset, and Ghidra display text.
- Address
Range - Address range reported by Ghidra.
- Analysis
Options - Analysis options for a program.
- Analysis
Report - Result metadata from a Ghidra analysis request.
- Basic
Block Info - Basic block in a control-flow graph.
- Call
Graph Edge - Program call graph edge.
- Call
Graph Node - Program call graph node.
- Control
Flow Edge Info - Edge between basic blocks.
- Control
Flow Graph - Basic-block control-flow graph.
- Data
Flow Edge - Edge between data-flow nodes.
- Data
Flow Graph - Data-flow graph derived from high P-code.
- Data
Flow Op - Data-flow operation node.
- Data
Flow Variable - Data-flow variable node.
- Data
Flow Varnode - Data-flow varnode node.
- Data
Info - Defined data item.
- Decompile
Options - Options for a single decompile request.
- Decompile
Result - Result of one decompiler request.
- Decompiler
- Reusable decompiler session for a program.
- Export
Info - Program entry point exported by Ghidra for a function.
- Function
Control Flow Graph - A function descriptor paired with its basic-block control-flow graph.
- Function
Descriptor - A function entry point and display name from a Ghidra program listing.
- Function
Prototype - Function prototype recovered by the decompiler.
- Function
Summary - Function-local facts collected from listing, symbol, reference, and source-map APIs.
- Ghidra
- Entry point for project and program operations.
- Ghidra
Runtime - Started embedded Ghidra JVM.
- High
Pcode Block - High P-code basic block.
- High
Pcode Graph - High P-code blocks, edges, and operations for a function.
- High
Symbol - High-level symbol recovered by the decompiler.
- Import
Info - External symbol referenced by a function.
- Instruction
Info - Listing instruction.
- Launch
Options - Options for starting the embedded Ghidra JVM.
- Loaded
Program - Result of opening or importing a program.
- Loader
Argument - Loader argument passed to Ghidra during import.
- Memory
Block Info - Program memory block.
- Named
Count - Name/count pair used by aggregate summaries.
- Operand
Info - Instruction operand.
- Pcode
OpInfo - P-code operation.
- Pcode
Summary - Counts and aggregate P-code facts for a decompiled function.
- Program
- Open Ghidra program handle tied to its owning project.
- Program
Call Graph - Program-level call graph.
- Program
Enum Value - Enum member metadata.
- Program
Function - Program function metadata record.
- Program
Function Signature - Program function signature metadata.
- Program
Load Info - Result metadata from opening or importing a program.
- Program
Load Options - Options for opening or importing a binary into a project.
- Program
Metadata - Program-wide symbols, functions, and recursive type metadata.
- Program
Open Options - Options for opening an already-imported program.
- Program
Parameter - Program function parameter metadata.
- Program
Path - Program path inside a Ghidra project.
- Program
Symbol - Program symbol metadata record.
- Program
Transaction - Open Ghidra transaction.
- Program
Type - Recursive program type metadata record.
- Program
Type Component - Structure or union component metadata.
- Program
Type Index - Borrowed index for resolving
ProgramTyperecords by ID. - Project
- Open Ghidra project handle.
- Reference
Info - Reference from one address to another.
- Source
MapInfo - Best source-file identity Ghidra can associate with a function.
- Symbol
Info - Symbol-table entry.
- Task
Monitor Options - Bridge task monitor configuration.
- Task
Monitor Report - Final state reported by a Ghidra task monitor.
- Varnode
Info - P-code varnode.
Enums§
- Analysis
Mode - Analysis mode to apply before extraction or API reads.
- Decompile
Status - Terminal status of a decompiler request.
- Error
- Error returned by Ghidra bridge and API operations.
- Export
Kind - Kind of exported program entry point.
- Import
Kind - Kind of external symbol referenced by a function.
- Program
Type Details - Recursive type variant details.
- Program
Type Index Error - Error returned when building or traversing a program type index.
- Runtime
Error - Error returned while discovering Ghidra or starting the embedded JVM.
- Symbol
Kind - Ghidra symbol kind.
- Symbol
Source - Source of a Ghidra symbol.
Functions§
Type Aliases§
- Result
- Result type used by this crate.