Struct subplot::Metadata

pub struct Metadata { /* private fields */ }

Metadata of a document, as needed by Subplot.

Implementations

impl Metadata

pub fn from_yaml_metadata<P>( basedir: P, yaml: &YamlMetadata, template: Option<&str> ) -> Result<Self, SubplotError>where P: AsRef<Path> + Debug,

Create from YamlMetadata.

pub fn title(&self) -> &str

Return title of document.

pub fn date(&self) -> Option<&str>

Return date of document, if any.

pub fn set_date(&mut self, date: String)

Set date.

pub fn authors(&self) -> Option<&[String]>

Authors.

pub fn basedir(&self) -> &Path

Return base dir for all relative filenames.

pub fn markdown_filenames(&self) -> &[PathBuf]

Return filenames of the markdown files.

pub fn bindings_filenames(&self) -> Vec<&Path>

Return filename where bindings are specified.

pub fn document_impl(&self, template: &str) -> Option<&DocumentImpl>

Return the document implementation (filenames, spec, etc) for the given template name

pub fn templates(&self) -> impl Iterator<Item = &str>

Return the templates the document expects to implement

pub fn bindings(&self) -> &Bindings

Return the bindings.

pub fn classes(&self) -> impl Iterator<Item = &str>

The classes which this document also claims are valid

Trait Implementations

impl Debug for Metadata

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

Formats the value using the given formatter.