Struct ModuleDoc 

pub struct ModuleDoc {
    pub module_path: String,
    pub content: String,
    pub source_file: String,
    pub c4_level: C4Level,
    pub pattern: String,
    pub pattern_status: PatternStatus,
    pub description: String,
    pub parent_container: Option<String>,
    pub relationships: Vec<Relationship>,
    pub files: Vec<FileEntry>,
}

A parsed module documentation unit.

This is the core data structure — the JSON IR contract between language adapters and the core generator.

Fields

module_path: String

content: String

source_file: String

c4_level: C4Level

pattern: String

pattern_status: PatternStatus

description: String

parent_container: Option<String>

relationships: Vec<Relationship>

files: Vec<FileEntry>

Trait Implementations

impl Clone for ModuleDoc

fn clone(&self) -> ModuleDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleDoc

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModuleDoc

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ModuleDoc

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ModuleDoc

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ModuleDoc

impl StructuralPartialEq for ModuleDoc