Struct ReferenceManual 

pub struct ReferenceManual {
    pub switchback_version: String,
    pub title: String,
    pub sources: Vec<Document>,
    pub modules: Vec<Module>,
}

Top-level switchback artifact every parser emits and every renderer reads.

Fields

switchback_version: String

Switchback container format version (distinct from contract spec versions).

title: String

Human-readable title for the reference manual.

sources: Vec<Document>

Verbatim source documents preserved for provenance and re-parse.

modules: Vec<Module>

Top-level documentation modules grouping contracts.

Trait Implementations

impl Clone for ReferenceManual

fn clone(&self) -> ReferenceManual

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReferenceManual

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

Formats the value using the given formatter.

impl Default for ReferenceManual

fn default() -> ReferenceManual

Returns the “default value” for a type.

impl Eq for ReferenceManual

impl PartialEq for ReferenceManual

fn eq(&self, other: &ReferenceManual) -> 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 StructuralPartialEq for ReferenceManual