Struct takeoff::document::Document

#[non_exhaustive]pub struct Document {
    pub content: String,
    pub metadata: Metadata,
    pub source_path: PathBuf,
}

A Document describes a Markdown file found in a Launchpad's source directory.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

content: String

The content of the Markdown file without the <!-- Metadata --> block if it was present.

metadata: Metadata

The parsed metadata.

source_path: PathBuf

The absolute path of the source Markdown file.

Implementations

impl Document

pub fn new(path: PathBuf) -> Result<Self>

Creates a new Document from a file. If parsing Metadata fails for this document, then an error is printed and Metadata::default() will be used instead.

pub fn create_destination(&self, launchpad: &Launchpad) -> Result<PathBuf>

Creates all the directories required and returns the HTML path where this Document should be written to.

Trait Implementations

impl Debug for Document

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Document

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Document

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

Serialize this value into the given Serde serializer.