Struct FunctionContext 

pub struct FunctionContext {
    pub name: String,
    pub file: String,
    pub start_line: usize,
    pub end_line: usize,
    pub signature: Option<String>,
    pub docstring: Option<String>,
    pub source: String,
    pub language: String,
}

Context about a function including its code and metadata.

This struct provides a complete context for a single function, suitable for LLM consumption. It matches Python’s FunctionContext dataclass for API parity.

Examples

use go_brrr::{FunctionContext, extract_file};

// Create from extracted function info
let module = extract_file("./src/main.py", None)?;
if let Some(func) = module.functions.first() {
    let source = std::fs::read_to_string("./src/main.py")?;
    let ctx = FunctionContext::from_function_info(func, "./src/main.py", &source, "python");
    println!("Function: {} at lines {}-{}", ctx.name, ctx.start_line, ctx.end_line);
}

Fields

name: String

Function name

file: String

File path containing the function

start_line: usize

Start line number (1-indexed)

end_line: usize

End line number (1-indexed)

signature: Option<String>

Function signature (e.g., “def foo(x: int) -> str”)

docstring: Option<String>

Docstring or documentation comment

source: String

Full source code of the function

language: String

Programming language (e.g., “python”, “rust”, “go”)

Implementations

impl FunctionContext

pub fn from_function_info( info: &FunctionInfo, file_path: &str, source: &str, language: &str, ) -> Self

Create a FunctionContext from a FunctionInfo and source file content.

Extracts the function source code from the full file content using the line number information in FunctionInfo.

Arguments

• info - The function info from AST extraction
• file_path - Path to the source file
• source - Full source content of the file
• language - Programming language identifier

Examples

use go_brrr::{FunctionContext, extract_file, FunctionInfo};

let module = extract_file("./src/lib.rs", None)?;
let source = std::fs::read_to_string("./src/lib.rs")?;

for func in &module.functions {
    let ctx = FunctionContext::from_function_info(func, "./src/lib.rs", &source, "rust");
    println!("{}: {} lines", ctx.name, ctx.end_line - ctx.start_line + 1);
}

pub fn minimal(name: &str, file: &str, line: usize, language: &str) -> Self

Create a minimal context with just name and file location.

Useful when you have limited information about a function reference.

Trait Implementations

impl Clone for FunctionContext

fn clone(&self) -> FunctionContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionContext

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionContext

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FunctionContext

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

where __S: Serializer,

Serialize this value into the given Serde serializer.