Struct tpnote_lib::front_matter::FrontMatter

pub struct FrontMatter {
    pub map: Map<String, Value>,
}

Represents the front matter of the note.

Fields

map: Map<String, Value>

Implementations

impl FrontMatter

pub fn assert_compulsory_field(&self) -> Result<(), NoteError>

Checks if the front matter contains a field variable with the name defined in the configuration file: as: “compulsory_header_field”.

pub fn assert_not_empty(&self) -> Result<(), NoteError>

Are any variables registerd?

Trait Implementations

impl Debug for FrontMatter

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

Formats the value using the given formatter.

impl PartialEq<FrontMatter> for FrontMatter

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&Content> for FrontMatter

fn try_from(content: &Content) -> Result<FrontMatter, NoteError>

Helper function deserialising the front-matter of the note file.

type Error = NoteError

The type returned in the event of a conversion error.

impl TryFrom<&str> for FrontMatter

fn try_from(header: &str) -> Result<FrontMatter, NoteError>

Helper function deserialising the front-matter of the note file.

type Error = NoteError

The type returned in the event of a conversion error.

impl Eq for FrontMatter

impl StructuralEq for FrontMatter

impl StructuralPartialEq for FrontMatter