Enum gray_matter::Pod

pub enum Pod {
    Null,
    String(String),
    Integer(i64),
    Float(f64),
    Boolean(bool),
    Array(Vec<Pod>),
    Hash(HashMap<String, Pod>),
}

A polyglot data type for representing the parsed front matter.

Any Engine has to convert the data represented by the format into a Pod. This ensures we can use the parsed data similarly, regardless of the format it is parsed from.

Variants

Null

String

Tuple Fields of String

0: String

Integer

Tuple Fields of Integer

0: i64

Float

Tuple Fields of Float

0: f64

Boolean

Tuple Fields of Boolean

0: bool

Array

Tuple Fields of Array

0: Vec<Pod>

Hash

Tuple Fields of Hash

0: HashMap<String, Pod>

Implementations

impl Pod

pub fn deserialize<T: DeserializeOwned>(&self) -> Result<T>

Deserialize a Pod into any struct that implements Deserialize.

Note: The function coerces self into a serde_json::Value in order to work around implementing a custom Deserializer for Pod.

pub fn new_array() -> Pod

pub fn new_hash() -> Pod

pub fn push<T>(&mut self, value: T) -> Result<(), Error> where
    T: Into<Pod>, 

Pushes a new value into Pod::Array.

pub fn pop(&mut self) -> Pod

Pops either the last element or null from Pod::Array.

pub fn insert<T>(&mut self, key: String, val: T) -> Result<(), Error> where
    T: Into<Pod>, 

Inserts a key value pair into or override the exist one in Pod::Hash.

pub fn remove(&mut self, key: String) -> Pod

Removes the value of specific key from Pod::Hash and returns it or null if not exists.

pub fn take(&mut self) -> Pod

Takes the ownership of Pod

pub fn len(&self) -> usize

Returns length of Pod::Array and Pod::Hash, 0 as default for other types.

pub fn as_string(&self) -> Result<String, Error>

pub fn as_i64(&self) -> Result<i64, Error>

pub fn as_f64(&self) -> Result<f64, Error>

pub fn as_bool(&self) -> Result<bool, Error>

pub fn as_vec(&self) -> Result<Vec<Pod>, Error>

pub fn as_hashmap(&self) -> Result<HashMap<String, Pod>, Error>

Trait Implementations

impl Clone for Pod

fn clone(&self) -> Pod

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pod

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

Formats the value using the given formatter.

impl From<HashMap<String, Pod, RandomState>> for Pod

fn from(val: HashMap<String, Pod>) -> Self

Performs the conversion.

impl From<String> for Pod

fn from(val: String) -> Self

Performs the conversion.

impl From<Vec<Pod, Global>> for Pod

fn from(val: Vec<Pod>) -> Self

Performs the conversion.

impl From<bool> for Pod

fn from(val: bool) -> Self

Performs the conversion.

impl From<f64> for Pod

fn from(val: f64) -> Self

Performs the conversion.

impl From<i64> for Pod

fn from(val: i64) -> Self

Performs the conversion.

impl<'a> Index<&'a str> for Pod

fn index(&self, index: &'a str) -> &Self::Output

Easily access value of Pod::Hash by &str index

type Output = Pod

The returned type after indexing.

impl Index<String> for Pod

fn index(&self, index: String) -> &Self::Output

Easily access value of Pod::Hash by String index

type Output = Pod

The returned type after indexing.

impl Index<usize> for Pod

fn index(&self, index: usize) -> &Self::Output

Easily access element of Pod::Array by usize index

type Output = Pod

The returned type after indexing.

impl<'a> IndexMut<&'a str> for Pod

fn index_mut(&mut self, index: &'a str) -> &mut Self::Output

Easily access mutable value of Pod::Hash by &str index

impl IndexMut<String> for Pod

fn index_mut(&mut self, index: String) -> &mut Self::Output

Easily access value of Pod::Hash by String index

impl IndexMut<usize> for Pod

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Easily access mutable element of Pod::Array by usize index

impl Into<HashMap<String, Pod, RandomState>> for Pod

fn into(self) -> HashMap<String, Pod>

Performs the conversion.

impl Into<Pod> for JsonValue

fn into(self) -> Pod

Performs the conversion.

impl Into<Pod> for TomlValue

fn into(self) -> Pod

Performs the conversion.

impl Into<Pod> for Yaml

fn into(self) -> Pod

Performs the conversion.

impl Into<String> for Pod

fn into(self) -> String

Performs the conversion.

impl Into<Value> for Pod

fn into(self) -> Value

Performs the conversion.

impl Into<Vec<Pod, Global>> for Pod

fn into(self) -> Vec<Pod>

Performs the conversion.

impl Into<bool> for Pod

fn into(self) -> bool

Performs the conversion.

impl Into<f64> for Pod

fn into(self) -> f64

Performs the conversion.

impl Into<i64> for Pod

fn into(self) -> i64

Performs the conversion.

impl PartialEq<Pod> for Pod

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

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

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

This method tests for !=.

impl StructuralPartialEq for Pod