Struct Function 

pub struct Function {
    pub range: AddressRange,
    pub name: Vec<u8>,
    pub lines: Vec<LineEntry>,
    pub inline: Option<InlineNode>,
    pub merged: Vec<Self>,
    pub call_sites: Vec<CallSite>,
}

Owned semantic function data accepted by a GSYM builder.

Only range and name are required; Function::new fills in the rest as empty. A function with no line rows and no inline tree still resolves an address to a name and an offset.

use gsym::{AddressRange, Function, LineEntry, FileIndex};

let plain = Function::new(AddressRange::new(0x1000, 0x1010), b"plain");
assert!(plain.lines.is_empty());

let with_lines = Function {
    lines: vec![LineEntry::new(0x1000, FileIndex::new(1), 42)],
    ..Function::new(AddressRange::new(0x1000, 0x1010), b"detailed")
};
assert_eq!(with_lines.lines.len(), 1);

merged holds aliases that share this function’s address range, which identical-code folding produces. They are written only when FunctionSetPolicy::MergeEqualRanges is enabled.

Fields

range: AddressRange

Function address range.

name: Vec<u8>

Function name as raw string-table bytes.

lines: Vec<LineEntry>

Sorted source-line rows belonging to this function.

inline: Option<InlineNode>

Root of the inline-call tree, when present.

merged: Vec<Self>

Equal-range aliases stored as merged FunctionInfo records.

call_sites: Vec<CallSite>

Call-site metadata for this function.

Implementations

impl Function

pub fn new(range: AddressRange, name: impl Into<Vec<u8>>) -> Self

Creates a function with no optional line, inline, merged, or call-site data.

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl Default for Function

fn default() -> Function

Returns the “default value” for a type.

impl Eq for Function

impl Ord for Function

fn cmp(&self, other: &Function) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Function

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Function

fn partial_cmp(&self, other: &Function) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Function