Struct pdb_addr2line::TypeFormatter

pub struct TypeFormatter<'t> { /* fields omitted */ }

Allows printing function signatures, for example for use in stack traces.

Procedure symbols in PDBs usually have a name string which only includes the function name, and no function arguments. Instead, the arguments need to be obtained from the symbol’s type information. TypeFormatter handles that.

The same is true for “inlinee” functions - these are referenced by their pdb::IdIndex, and their IdData’s name string again only contains the raw function name but no arguments and also no namespace or class name. TypeFormatter handles those, too, in TypeFormatter::format_id.

Implementations

impl<'t> TypeFormatter<'t>

pub fn new(
    debug_info: &DebugInformation<'_>,
    type_info: &'t TypeInformation<'_>,
    id_info: &'t IdInformation<'_>,
    flags: TypeFormatterFlags
) -> Result<Self, Error>

Create a new TypeFormatter with the help of various PDB streams.

pub fn get_type_size(&self, index: TypeIndex) -> u32

Get the size, in bytes, of the type at index.

pub fn format_function(
    &self,
    name: &str,
    function_type_index: TypeIndex
) -> Result<String, Error>

Return a string with the function or method signature, including return type (if requested), namespace and/or class qualifiers, and arguments. If the TypeIndex is 0, then only the raw name is emitted. In that case, the name may need to go through additional demangling / “undecorating”, but this is the responsibility of the caller. This method is used for ProcedureSymbols.

pub fn emit_function(
    &self,
    w: &mut impl Write,
    name: &str,
    function_type_index: TypeIndex
) -> Result<(), Error>

Write out the function or method signature, including return type (if requested), namespace and/or class qualifiers, and arguments. If the TypeIndex is 0, then only the raw name is emitted. In that case, the name may need to go through additional demangling / “undecorating”, but this is the responsibility of the caller. This method is used for ProcedureSymbols.

pub fn format_id(&self, id_index: IdIndex) -> Result<String, Error>

Return a string with the function or method signature, including return type (if requested), namespace and/or class qualifiers, and arguments. This method is used for inlined functions.

pub fn emit_id(
    &self,
    w: &mut impl Write,
    id_index: IdIndex
) -> Result<(), Error>

Write out the function or method signature, including return type (if requested), namespace and/or class qualifiers, and arguments. This method is used for inlined functions.