Struct ModuleInfo 

pub struct ModuleInfo {
    pub path: String,
    pub language: String,
    pub docstring: Option<String>,
    pub functions: Vec<FunctionInfo>,
    pub classes: Vec<ClassInfo>,
    pub imports: Vec<ImportInfo>,
    pub call_graph: Option<CallGraphInfo>,
}

Information about a complete module/file.

Fields

path: String

File path (serializes as “file_path” for Python compatibility)

language: String

Detected language

docstring: Option<String>

Module-level docstring (e.g., Python module docstrings)

functions: Vec<FunctionInfo>

Top-level functions

classes: Vec<ClassInfo>

Classes/structs

imports: Vec<ImportInfo>

Import statements

call_graph: Option<CallGraphInfo>

Module-level call graph (function relationships within this module). None if not computed (call graph extraction is optional/expensive).

Implementations

impl ModuleInfo

pub fn to_dict(&self) -> Value

Convert to dictionary format with computed signatures.

Returns a complete JSON representation suitable for serialization, with all function and class signatures pre-computed. This format matches the Python ModuleInfo.to_dict() output for compatibility.

Serialization helper for library consumers needing full module representation.

pub fn to_compact(&self) -> Value

Convert to compact format optimized for LLM context.

Returns a condensed JSON representation that minimizes token usage while preserving essential information.

Serialization helper for library consumers needing compact representation.

pub fn to_compact_with_limits( &self, max_module_doc_len: usize, max_class_doc_len: usize, ) -> Value

Convert to compact format with custom docstring length limits.

Serialization helper for library consumers needing compact representation.

Trait Implementations

impl Clone for ModuleInfo

fn clone(&self) -> ModuleInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleInfo

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

Formats the value using the given formatter.

impl Default for ModuleInfo

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModuleInfo

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ModuleInfo

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

where __S: Serializer,

Serialize this value into the given Serde serializer.