CallGraphBuilder

Struct CallGraphBuilder 

Source
pub struct CallGraphBuilder<'a> { /* private fields */ }
Expand description

Builds a call graph by recursively tracing function calls.

§Rust Book Reference

Chapter 10.3: Validating References with Lifetimes https://doc.rust-lang.org/book/ch10-03-lifetime-syntax.html

§Educational Notes - Lifetime Parameters

This struct demonstrates explicit lifetime annotations:

pub struct CallGraphBuilder<'a> {
    finder: &'a mut FunctionFinder,
    extractor: &'a CallExtractor,
}

What does <'a> mean?

  • 'a is a lifetime parameter (read as “lifetime a”)
  • It says: “This struct holds references that live for lifetime ’a”
  • The struct cannot outlive the data it references

Why do we need lifetimes here?

  • CallGraphBuilder stores references to FunctionFinder and CallExtractor
  • Without lifetimes, Rust doesn’t know how long these references are valid
  • The lifetime 'a connects the struct’s lifetime to its references

What does this prevent?

let builder = {
    let finder = FunctionFinder::new(...);
    let extractor = CallExtractor::new(...);
    CallGraphBuilder::new(..., &mut finder, &extractor)
}; // ERROR! finder and extractor are dropped here
// builder would have dangling references!

The lifetime constraint:

  • CallGraphBuilder<'a> can only exist while finder and extractor exist
  • Rust enforces this at compile time
  • No runtime overhead - pure compile-time safety

Alternative without lifetimes:

  • Could use Box<FunctionFinder> (heap allocation + ownership)
  • Could use Rc<RefCell<FunctionFinder>> (reference counting + runtime checks)
  • Lifetimes are zero-cost: no allocation, no runtime checks

Implementations§

Source§

impl<'a> CallGraphBuilder<'a>

Source

pub fn new( direction: TraceDirection, max_depth: usize, finder: &'a mut FunctionFinder, extractor: &'a CallExtractor, ) -> Self

Create a new CallGraphBuilder.

§Rust Book Reference

Chapter 10.3: Lifetime Annotations in Function Signatures https://doc.rust-lang.org/book/ch10-03-lifetime-syntax.html#lifetime-annotations-in-function-signatures

§Educational Notes - Lifetime in Function Signatures

This function signature shows how lifetimes flow through constructors:

pub fn new(
    finder: &'a mut FunctionFinder,
    extractor: &'a CallExtractor,
) -> Self

What this means:

  • The returned CallGraphBuilder<'a> contains references with lifetime 'a
  • Those references come from the input parameters
  • The builder cannot outlive finder or extractor

Lifetime elision: Without the struct’s <'a>, we’d need to write:

pub fn new<'a>(
    finder: &'a mut FunctionFinder,
    extractor: &'a CallExtractor,
) -> CallGraphBuilder<'a>

But since the struct already has <'a>, we can use Self.

§Arguments
  • direction - Whether to trace forward or backward
  • max_depth - Maximum depth of the call tree
  • finder - Service to find function definitions
  • extractor - Service to extract calls from code
Source

pub fn build_trace( &mut self, start_fn: &FunctionDef, ) -> Result<Option<CallTree>>

Build a call trace tree starting from the given function

Auto Trait Implementations§

§

impl<'a> Freeze for CallGraphBuilder<'a>

§

impl<'a> RefUnwindSafe for CallGraphBuilder<'a>

§

impl<'a> Send for CallGraphBuilder<'a>

§

impl<'a> Sync for CallGraphBuilder<'a>

§

impl<'a> Unpin for CallGraphBuilder<'a>

§

impl<'a> !UnwindSafe for CallGraphBuilder<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.