Struct tpnote_lib::front_matter::FrontMatter

pub struct FrontMatter(pub Map<String, Value>);

Represents the front matter of the note. This is a newtype for tera::Map<String, tera::Value>.

Tuple Fields

0: 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?

Methods from Deref<Target = Map<String, Value>>

pub fn clear(&mut self)

Clears the map, removing all values.

pub fn get<Q>(&self, key: &Q) -> Option<&Value>where
    String: Borrow<Q>,
    Q: Ord + Eq + Hash + ?Sized,

Returns a reference to the value corresponding to the key.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn contains_key<Q>(&self, key: &Q) -> boolwhere
    String: Borrow<Q>,
    Q: Ord + Eq + Hash + ?Sized,

Returns true if the map contains a value for the specified key.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut Value>where
    String: Borrow<Q>,
    Q: Ord + Eq + Hash + ?Sized,

Returns a mutable reference to the value corresponding to the key.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn get_key_value<Q>(&self, key: &Q) -> Option<(&String, &Value)>where
    String: Borrow<Q>,
    Q: Ord + Eq + Hash + ?Sized,

Returns the key-value pair matching the given key.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn insert(&mut self, k: String, v: Value) -> Option<Value>

Inserts a key-value pair into the map.

If the map did not have this key present, None is returned.

If the map did have this key present, the value is updated, and the old value is returned.

pub fn remove<Q>(&mut self, key: &Q) -> Option<Value>where
    String: Borrow<Q>,
    Q: Ord + Eq + Hash + ?Sized,

Removes a key from the map, returning the value at the key if the key was previously in the map.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn remove_entry<Q>(&mut self, key: &Q) -> Option<(String, Value)>where
    String: Borrow<Q>,
    Q: Ord + Eq + Hash + ?Sized,

Removes a key from the map, returning the stored key and value if the key was previously in the map.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn append(&mut self, other: &mut Map<String, Value>)

Moves all elements from other into self, leaving other empty.

pub fn entry<S>(&mut self, key: S) -> Entry<'_>where
    S: Into<String>,

Gets the given key’s corresponding entry in the map for in-place manipulation.

pub fn len(&self) -> usize

Returns the number of elements in the map.

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

pub fn iter(&self) -> Iter<'_>

Gets an iterator over the entries of the map.

pub fn iter_mut(&mut self) -> IterMut<'_>

Gets a mutable iterator over the entries of the map.

pub fn keys(&self) -> Keys<'_>

Gets an iterator over the keys of the map.

pub fn values(&self) -> Values<'_>

Gets an iterator over the values of the map.

pub fn values_mut(&mut self) -> ValuesMut<'_>

Gets an iterator over mutable values of the map.

pub fn retain<F>(&mut self, f: F)where
    F: FnMut(&String, &mut Value) -> bool,

Retains only the elements specified by the predicate.

In other words, remove all pairs (k, v) such that f(&k, &mut v) returns false.

Trait Implementations

impl Debug for FrontMatter

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

Formats the value using the given formatter.

impl Deref for FrontMatter

Auto-dereference for convenient access to tera::Map.

type Target = Map<String, Value>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for FrontMatter

Auto-dereference for convenient access to tera::Map.

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

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 ==.

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.

use tpnote_lib::content::Content;
use tpnote_lib::front_matter::FrontMatter;
use serde_json::json;
// Create existing note.
let raw = "\u{feff}---\ntitle: \"My day\"\nsubtitle: \"Note\"\n---\nBody";
let content = Content::from(raw.to_string());
assert!(!content.is_empty());
assert!(!content.borrow_dependent().header.is_empty());

let front_matter = FrontMatter::try_from(&content).unwrap();
assert_eq!(front_matter.get("title"), Some(&json!("My day")));
assert_eq!(front_matter.get("subtitle"), Some(&json!("Note")));

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