pub struct Metadata { /* private fields */ }
Expand description
Metadata of a document, as needed by Subplot.
Implementations§
source§impl Metadata
impl Metadata
sourcepub fn from_yaml_metadata<P>(
basedir: P,
yaml: &YamlMetadata,
template: Option<&str>,
) -> Result<Self, SubplotError>
pub fn from_yaml_metadata<P>( basedir: P, yaml: &YamlMetadata, template: Option<&str>, ) -> Result<Self, SubplotError>
Create from YamlMetadata.
Authors.
sourcepub fn markdown_filenames(&self) -> &[PathBuf]
pub fn markdown_filenames(&self) -> &[PathBuf]
Return filenames of the markdown files.
sourcepub fn bindings_filenames(&self) -> Vec<&Path>
pub fn bindings_filenames(&self) -> Vec<&Path>
Return filename where bindings are specified.
sourcepub fn document_impl(&self, template: &str) -> Option<&DocumentImpl>
pub fn document_impl(&self, template: &str) -> Option<&DocumentImpl>
Return the document implementation (filenames, spec, etc) for the given template name
sourcepub fn templates(&self) -> impl Iterator<Item = &str>
pub fn templates(&self) -> impl Iterator<Item = &str>
Return the templates the document expects to implement
sourcepub fn classes(&self) -> impl Iterator<Item = &str>
pub fn classes(&self) -> impl Iterator<Item = &str>
The classes which this document also claims are valid
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Metadata
impl RefUnwindSafe for Metadata
impl Send for Metadata
impl Sync for Metadata
impl Unpin for Metadata
impl UnwindSafe for Metadata
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more