Struct bloguen::ops::PostMetadata

pub struct PostMetadata {
    pub language: Option<LanguageTag>,
    pub author: Option<String>,
    pub tags: Vec<TagName>,
    pub styles: Vec<StyleElement>,
    pub scripts: Vec<ScriptElement>,
    pub data: BTreeMap<String, String>,
}

Generic post metadata.

Fields

language: Option<LanguageTag>

Post language override.

If not present, default post language is used.

author: Option<String>

Post author override.

If not present, default post author is used.

tags: Vec<TagName>

A set of tags.

If not present, defaults to empty.

styles: Vec<StyleElement>

A set of style descriptors.

If not present, defaults to empty.

scripts: Vec<ScriptElement>

A set of style descriptors.

If not present, defaults to empty.

data: BTreeMap<String, String>

Additional static data to substitute in header and footer.

If not present, defaults to empty.

Methods

impl PostMetadata

pub fn read_or_default(
    post_root: &(String, PathBuf)
) -> Result<PostMetadata, Error>

Read the post metadata from the specified root directory.

If the metadata file doesn't exist, Ok(Default::default()) is returned.

Examples

Given $POST_ROOT/metadata.toml containing:

language = "pl"
tags = ["vodka", "depression"]

[[scripts]]
class = "link"
data = "/content/assets/syllable.js"

[[scripts]]
class = "file"
data = "MathJax-config.js"

[data]
desc = "Każdy koniec to nowy początek [PL]"

The following holds:

let post_root: PathBuf = /* obtained elsewhere */;
let metadata =
    PostMetadata::read_or_default(&("$POST_ROOT/".to_string(), post_root.clone())).unwrap();
assert_eq!(metadata,
           PostMetadata {
               language: Some("pl".parse().unwrap()),
               author: None,
               tags: vec!["vodka".parse().unwrap(), "depression".parse().unwrap()],
               styles: vec![],
               scripts: vec![ScriptElement::from_link("/content/assets/syllable.js"),
                             ScriptElement::from_path("MathJax-config.js")],
               data: vec![("desc".to_string(),
                           "Każdy koniec to nowy początek [PL]".to_string())]
                         .into_iter().collect(),
           });

Trait Implementations

impl Eq for PostMetadata

impl Default for PostMetadata

fn default() -> PostMetadata

Returns the "default value" for a type.

impl Clone for PostMetadata

fn clone(&self) -> PostMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<PostMetadata> for PostMetadata

fn partial_cmp(&self, other: &PostMetadata) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &PostMetadata) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &PostMetadata) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &PostMetadata) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &PostMetadata) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<PostMetadata> for PostMetadata

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

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

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

This method tests for !=.

impl Ord for PostMetadata

fn cmp(&self, other: &PostMetadata) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Hash for PostMetadata

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Debug for PostMetadata

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

Formats the value using the given formatter.