Struct Doc 

pub struct Doc {

    pub id: DocId,
    pub path: String,
    pub dir: Option<String>,
    pub tier: Tier,
    pub slug: String,
    pub frontmatter: Frontmatter,
    pub title: Option<String>,
    pub chapters: Vec<String>,
    pub bundle_files: Vec<String>,
    pub links: Vec<Located<String>>,
    pub anchors: Vec<Located<String>>,
    pub path_cites: Vec<Located<String>>,
    pub body_lines: usize,
    pub body_hash: String,
}

Fields

id: DocId

path: String

The main Markdown file, relative to the repository root.

dir: Option<String>

The bundle directory of a directory-form document.

tier: Tier

slug: String

The slug part of the file name.

frontmatter: Frontmatter

title: Option<String>

chapters: Vec<String>

Chapter files inside the bundle.

bundle_files: Vec<String>

Non-Markdown files inside the bundle, relative to the repository root.

links: Vec<Located<String>>

anchors: Vec<Located<String>>

path_cites: Vec<Located<String>>

body_lines: usize

body_hash: String

Hash of the main file’s body, for sealed documents.

Implementations

impl Doc

pub fn fm(&self) -> Option<&Map<String, Value>>

pub fn str_field(&self, key: &str) -> Option<String>

pub fn list_field(&self, key: &str) -> Vec<String>

pub fn status(&self) -> Option<String>

pub fn rel(&self) -> BTreeMap<String, Vec<String>>

Typed relations: rel.<kind> lists.

pub fn files(&self) -> Vec<FileEntry>

pub fn base_dir(&self) -> String

The directory attachments are relative to: the bundle, or the main file’s directory.

Trait Implementations

impl Clone for Doc

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 Doc

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

Formats the value using the given formatter.