Struct McdDocument 

pub struct McdDocument {
    pub source_path: String,
    pub blocks: Vec<DocumentBlock>,
}

Parsed MCD document with a canonical block stream.

Fields

source_path: String

Source Markdown path inside the package.

blocks: Vec<DocumentBlock>

Blocks in source order.

Implementations

impl McdDocument

pub fn from_package(package: &McdPackage, manifest: &Manifest) -> Result<Self>

Parse the manifest entrypoint Markdown from a package.

Trait Implementations

impl Clone for McdDocument

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for McdDocument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for McdDocument

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for McdDocument

impl PartialEq for McdDocument

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for McdDocument

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for McdDocument