Struct subplot::YamlMetadata

pub struct YamlMetadata { /* private fields */ }

Document metadata.

This is expressed in the Markdown input file as an embedded YAML block.

Note that this structure needs to be able to capture any metadata block we can work with, in any input file. By being strict here we make it easier to tell the user when a metadata block has, say, a misspelled field.

Implementations

impl YamlMetadata

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

Names of files with the Markdown for the subplot document.

pub fn title(&self) -> &str

Title.

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

Subtitle.

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

Date.

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

Set date.

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

Authors.

pub fn bindings_filenames(&self) -> Option<&[PathBuf]>

Names of bindings files.

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

Impls section.

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

Classes..

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

Documentclass.

Trait Implementations

impl Clone for YamlMetadata

fn clone(&self) -> YamlMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for YamlMetadata

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

Formats the value using the given formatter.

impl Default for YamlMetadata

fn default() -> YamlMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for YamlMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.