Struct Function

pub struct Function<'input> { /* private fields */ }

A function.

Implementations

impl<'input> Function<'input>

pub fn id(&self) -> usize

The user defined id for this function.

pub fn set_id(&self, id: usize)

Set a user defined id for this function.

pub fn namespace(&self) -> Option<&Namespace<'_>>

The namespace of the function.

pub fn name(&self) -> Option<&str>

The name of the function.

pub fn linkage_name(&self) -> Option<&str>

The linkage name of the variable.

pub fn symbol_name(&self) -> Option<&str>

The symbol name of the function.

This is determined from a symbol table entry with a matching address.

pub fn source(&self) -> &Source<'input>

The source information for the function.

pub fn address(&self) -> Option<u64>

The address of the function.

pub fn size(&self) -> Option<u64>

The size in bytes of the function.

This may exclude padding, and may be non-contiguous.

pub fn ranges(&self) -> &[Range]

The address ranges of the function.

pub fn is_inline(&self) -> bool

Return true if this is an inlined function.

pub fn is_declaration(&self) -> bool

Return true if this is a declaration.

pub fn parameters(&self) -> &[ParameterType<'input>]

The function parameter types.

pub fn return_type<'a>( &self, hash: &'a FileHash<'input>, ) -> Option<Cow<'a, Type<'input>>>

The return type.

Returns None if the return type is invalid.

pub fn details(&self, hash: &FileHash<'input>) -> FunctionDetails<'input>

Extra function details.

pub fn cmp_id( _hash_a: &FileHash<'_>, a: &Function<'_>, _hash_b: &FileHash<'_>, b: &Function<'_>, ) -> Ordering

Compare the identifying information of two functions.

Functions are equal if they have the same namespace and name.

This can be used to sort, and to determine if two functions refer to the same definition (even if there are differences in the definitions).

Trait Implementations

impl<'input> Debug for Function<'input>

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

Formats the value using the given formatter.

impl<'input> Default for Function<'input>

fn default() -> Function<'input>

Returns the “default value” for a type.