Struct Document 

pub struct Document {
    pub children: Vec<Block>,
    pub title: Option<Vec<Inline>>,
    pub subtitle: Option<Vec<Inline>>,
    pub header: Vec<Block>,
    pub footer: Vec<Block>,
    pub next_id: usize,
    pub messages: Vec<SystemMessage>,
    pub meta: Vec<(String, String)>,
}

Parsed document: section tree plus collected metadata.

Fields

children: Vec<Block>

title: Option<Vec<Inline>>

subtitle: Option<Vec<Inline>>

header: Vec<Block>

.. header:: / .. footer:: decoration bodies.

footer: Vec<Block>

next_id: usize

Next free linkage number for message/problematic ids.

messages: Vec<SystemMessage>

Non-halting parse problems, in document order.

meta: Vec<(String, String)>

.. meta:: name/content pairs for the HTML head.

Implementations

impl Document

pub fn astext(&self) -> String

Examples found in repository

examples/publish.rs (line 40)

fn main() {
    let path = std::env::args().nth(1).expect("usage: publish <file.rst>");
    let source = std::fs::read_to_string(&path).expect("read input");
    // Parity harness: report everything (mirrors the oracle at
    // report_level 1); default filtering is covered by unit tests.
    let settings = Settings {
        report_level: 1,
        ..Settings::default()
    };
    let doc = match publish_doctree_with(&source, &settings, None) {
        Ok(doc) => doc,
        Err(h) => {
            eprintln!("HALT {h}");
            std::process::exit(1);
        }
    };
    eprintln!("-- messages:");
    for m in &doc.messages {
        let line = m
            .line
            .map(|n| n.to_string())
            .unwrap_or_else(|| "None".into());
        eprintln!(
            "MSG level={} line={} {}",
            m.level,
            line,
            m.text.replace('\n', "\\n")
        );
    }
    eprintln!("-- astext --");
    eprintln!("{}", doc.astext());
    match publish_string_with(&source, &settings, None) {
        Ok((html, _)) => println!("{html}"),
        Err(h) => {
            eprintln!("HALT {h}");
            std::process::exit(1);
        }
    }
}

Trait Implementations

impl Clone for Document

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 Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Document

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Document