Struct subplot::Document

pub struct Document { /* fields omitted */ }

A parsed Subplot document.

Pandoc works by parsing its various input files and constructing an abstract syntax tree or AST. When Pandoc generates output, it works based on the AST. This way, the input parsing and output generation are cleanly separated.

A Pandoc filter can modify the AST before output generation starts working. This allows the filter to make changes to what gets output, without having to understand the input documents at all.

This function is a Pandoc filter, to be use with pandoc_ast::filter, for typesetting Subplot documents.

Example

fix this example;

let markdown = "\
---
title: Test Title
...
This is a test document.
";

use std::io::Write;
use tempfile::NamedTempFile;
let mut f = NamedTempFile::new().unwrap();
f.write_all(markdown.as_bytes()).unwrap();
let filename = f.path();

use subplot;
let basedir = std::path::Path::new(".");
let style = subplot::Style::default();
let doc = subplot::Document::from_file(&basedir, filename, style).unwrap();
assert_eq!(doc.files(), &[]);

Implementations

impl<'a> Document

pub fn from_json<P>(
    basedir: P,
    markdowns: Vec<PathBuf>,
    json: &str,
    style: Style
) -> Result<Document> where
    P: AsRef<Path> + Debug, 

Construct a Document from a JSON AST

pub fn from_file(
    basedir: &Path,
    filename: &Path,
    style: Style
) -> Result<Document>

Construct a Document from a named file.

The file can be in any format Pandoc understands. This runs Pandoc to parse the file into an AST, so it can be a little slow.

pub fn from_file_with_pullmark(
    basedir: &Path,
    filename: &Path,
    style: Style
) -> Result<Document>

Construct a Document from a named file, using the pullmark_cmark crate.

The file can be in the CommonMark format, with some extensions. This uses the pulldown-cmark crate to parse the file into an AST.

pub fn ast(&self) -> Result<String>

Return the AST of a Document, serialized as JSON.

This is useful in a Pandoc filter, so that the filter can give it back to Pandoc for typesetting.

pub fn meta(&self) -> &Metadata

Return the document’s metadata.

pub fn sources(&mut self) -> Vec<PathBuf>

Return all source filenames for the document.

The sources are any files that affect the output so that if the source file changes, the output needs to be re-generated.

pub fn files(&self) -> &[DataFile]

Return list of files embeddedin the document.

pub fn lint(&self) -> Result<()>

Check the document for common problems.

pub fn check_named_files_exist(&mut self, template: &str) -> Result<bool>

Check that all named files (in matched steps) are actually present in the document.

pub fn check_matched_steps_have_impl(&mut self, template: &str) -> bool

Check that all matched steps actually have function implementations

pub fn typeset(&mut self)

Typeset a Subplot document.

pub fn scenarios(&mut self) -> Result<Vec<Scenario>>

Return all scenarios in a document.

pub fn matched_scenarios(
    &mut self,
    template: &str
) -> Result<Vec<MatchedScenario>>

Return matched scenarios in a document.

Trait Implementations

impl Debug for Document

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

Formats the value using the given formatter.