Struct RelevantContext 

pub struct RelevantContext {
    pub entry: FunctionContext,
    pub callees: Vec<FunctionContext>,
    pub callers: Vec<FunctionContext>,
    pub token_count: usize,
    pub depth: usize,
}

Relevant context for LLM consumption with call graph information.

This struct aggregates function context for an entry point along with its direct callees and callers, providing a complete picture for LLM analysis. Matches Python’s RelevantContext dataclass for API parity.

Examples

use go_brrr::{RelevantContext, FunctionContext};

// Build context programmatically
let entry = FunctionContext::minimal("main", "src/main.rs", 10, "rust");
let callee = FunctionContext::minimal("helper", "src/utils.rs", 25, "rust");

let context = RelevantContext {
    entry,
    callees: vec![callee],
    callers: vec![],
    token_count: 500,
    depth: 1,
};

println!("Entry: {} calls {} functions", context.entry.name, context.callees.len());

Fields

entry: FunctionContext

The entry point function being analyzed

callees: Vec<FunctionContext>

Functions called by the entry point (direct dependencies)

callers: Vec<FunctionContext>

Functions that call the entry point (reverse dependencies)

token_count: usize

Estimated token count for LLM context window budgeting

depth: usize

Depth of call graph traversal used

Implementations

impl RelevantContext

pub fn new(entry: FunctionContext, depth: usize) -> Self

Create a new RelevantContext with just an entry point.

Callees and callers are initialized empty; use builder pattern to add them.

pub fn with_callee(self, callee: FunctionContext) -> Self

Add a callee (function called by entry point).

pub fn with_caller(self, caller: FunctionContext) -> Self

Add a caller (function that calls the entry point).

pub fn with_token_count(self, count: usize) -> Self

Set the token count estimate.

pub fn estimate_tokens(&mut self)

Calculate approximate token count based on source code length.

Uses a rough estimate of 4 characters per token.

pub fn function_count(&self) -> usize

Total number of functions in this context.

pub fn to_llm_string(&self) -> String

Format context as a string suitable for LLM prompts.

Produces a structured representation showing the entry point and its relationships to other functions.

Trait Implementations

impl Clone for RelevantContext

fn clone(&self) -> RelevantContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelevantContext

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RelevantContext

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RelevantContext

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.