Struct DocModel 

pub struct DocModel {
    pub metadata: ProjectMetadata,
    pub rust_modules: Vec<RustModule>,
    pub python_modules: Vec<PythonModule>,
    pub cross_refs: Vec<CrossRef>,
}

The complete documentation model for a project

Fields

metadata: ProjectMetadata

rust_modules: Vec<RustModule>

python_modules: Vec<PythonModule>

cross_refs: Vec<CrossRef>

Implementations

impl DocModel

pub fn test(name: impl Into<String>) -> Self

Create an empty doc model for testing

pub fn with_rust_module(self, module: RustModule) -> Self

pub fn with_python_module(self, module: PythonModule) -> Self

pub fn with_cross_ref(self, cross_ref: CrossRef) -> Self

Trait Implementations

impl Clone for DocModel

fn clone(&self) -> DocModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocModel

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocModel

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocModel

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

where __S: Serializer,

Serialize this value into the given Serde serializer.