Struct EumdDocument 

pub struct EumdDocument {
    pub schema: Option<String>,
    pub title: String,
    pub authors: Vec<Author>,
    pub date: Option<String>,
    pub tags: Vec<String>,
    pub draft: Option<bool>,
    pub description: Option<String>,
    pub cites: Option<String>,
    pub footnotes: Map<String, Footnote>,
    pub intro: Option<String>,
    pub sections: Map<String, Section>,
}

Root document structure for .eumd files

Fields

schema: Option<String>

Schema reference (extension field)

title: String

Document title (inline markdown)

authors: Vec<Author>

Document authors

date: Option<String>

Publication/creation date

tags: Vec<String>

Categorization tags

draft: Option<bool>

Draft status

description: Option<String>

Document description/abstract (block markdown)

cites: Option<String>

Bibliography in BibTeX format

footnotes: Map<String, Footnote>

Footnote definitions

intro: Option<String>

Introduction/preamble before first section

sections: Map<String, Section>

Document sections (map with ID as key)

Implementations

impl EumdDocument

pub fn get_section_header<'a>(key: &'a str, section: &'a Section) -> &'a str

Get the effective header for a section (uses key if header is None)

Trait Implementations

impl Clone for EumdDocument

fn clone(&self) -> EumdDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EumdDocument

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

Formats the value using the given formatter.

impl<'doc> ParseDocument<'doc> for EumdDocument

type Error = ParseError

The error type returned by parsing.

fn parse(ctx: &ParseContext<'doc>) -> Result<Self, Self::Error>

Parse a value of this type from the given parse context.

impl PartialEq for EumdDocument

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