Struct binaryninja::debuginfo::DebugInfo

pub struct DebugInfo { /* private fields */ }

Provides an interface to both provide and query debug info. The DebugInfo object is used internally by the binary view to which it is applied to determine the attributes of functions, types, and variables that would otherwise be costly to deduce.

DebugInfo objects themselves are independent of binary views; their data can be sourced from any arbitrary binary views and be applied to any other arbitrary binary view. A DebugInfo object can also contain debug info from multiple DebugInfoParsers. This makes it possible to gather debug info that may be distributed across several different formats and files.

DebugInfo cannot be instantiated by the user, instead get it from either the binary view (see binaryninja::binaryview::BinaryView::debug_info) or a debug-info parser (see binaryninja::debuginfo::DebugInfoParser::parse_debug_info).

Please note that calling one of add_* functions will not work outside of a debuginfo plugin.

Implementations

impl DebugInfo

pub fn types_by_name<S: BnStrCompatible>(
    &self,
    parser_name: S
) -> Vec<NameAndType<String>>

Returns a generator of all types provided by a named DebugInfoParser

pub fn types(&self) -> Vec<NameAndType<String>>

A generator of all types provided by DebugInfoParsers

pub fn functions_by_name<S: BnStrCompatible>(
    &self,
    parser_name: S
) -> Vec<DebugFunctionInfo>

Returns a generator of all functions provided by a named DebugInfoParser

pub fn functions(&self) -> Vec<DebugFunctionInfo>

A generator of all functions provided by DebugInfoParsers

pub fn data_variables_by_name<S: BnStrCompatible>(
    &self,
    parser_name: S
) -> Vec<DataVariableAndName<String>>

Returns a generator of all data variables provided by a named DebugInfoParser

pub fn data_variables(&self) -> Vec<DataVariableAndName<String>>

A generator of all data variables provided by DebugInfoParsers

pub fn type_by_name<S: BnStrCompatible>(
    &self,
    parser_name: S,
    name: S
) -> Option<Ref<Type>>

May return nullptr

pub fn get_data_variable_by_name<S: BnStrCompatible>(
    &self,
    parser_name: S,
    name: S
) -> Option<(u64, Ref<Type>)>

pub fn get_data_variable_by_address<S: BnStrCompatible>(
    &self,
    parser_name: S,
    address: u64
) -> Option<(String, Ref<Type>)>

pub fn get_types_by_name<S: BnStrCompatible>(
    &self,
    name: S
) -> Vec<(String, Ref<Type>)>

pub fn get_data_variables_by_name<S: BnStrCompatible>(
    &self,
    name: S
) -> Vec<(String, u64, Ref<Type>)>

pub fn get_data_variables_by_address(
    &self,
    address: u64
) -> Vec<(String, String, Ref<Type>)>

The tuple is (DebugInfoParserName, TypeName, type)

pub fn remove_parser_info<S: BnStrCompatible>(&self, parser_name: S) -> bool

pub fn remove_parser_types<S: BnStrCompatible>(&self, parser_name: S) -> bool

pub fn remove_parser_functions<S: BnStrCompatible>(&self, parser_name: S) -> bool

pub fn remove_parser_data_variables<S: BnStrCompatible>(
    &self,
    parser_name: S
) -> bool

pub fn remove_type_by_name<S: BnStrCompatible>(
    &self,
    parser_name: S,
    name: S
) -> bool

pub fn remove_function_by_index<S: BnStrCompatible>(
    &self,
    parser_name: S,
    index: usize
) -> bool

pub fn remove_data_variable_by_address<S: BnStrCompatible>(
    &self,
    parser_name: S,
    address: u64
) -> bool

pub fn add_type<S: BnStrCompatible>(
    &self,
    name: S,
    new_type: &Type,
    components: &[&str]
) -> bool

Adds a type scoped under the current parser’s name to the debug info

pub fn add_function(&self, new_func: DebugFunctionInfo) -> bool

Adds a function scoped under the current parser’s name to the debug info

pub fn add_data_variable<S: BnStrCompatible>(
    &self,
    address: u64,
    t: &Type,
    name: Option<S>,
    components: &[&str]
) -> bool

Adds a data variable scoped under the current parser’s name to the debug info

pub fn add_data_variable_info<S: BnStrCompatible>(
    &self,
    var: DataVariableAndName<S>
) -> bool

Trait Implementations

impl Hash for DebugInfo

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<DebugInfo> for DebugInfo

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl RefCountable for DebugInfo

unsafe fn inc_ref(handle: &Self) -> Ref<Self>

unsafe fn dec_ref(handle: &Self)

impl ToOwned for DebugInfo

type Owned = Ref<DebugInfo>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl Eq for DebugInfo

impl StructuralEq for DebugInfo

impl StructuralPartialEq for DebugInfo