pub struct FrontMatter {
pub title: Option<String>,
pub date: Option<String>,
pub tags: Vec<String>,
pub draft: bool,
pub layout: Option<String>,
pub description: Option<String>,
}Expand description
Metadata block at the top of a Markdown file.
All fields are optional at the serde layer so missing or partial front matter never panics the compiler. Malformed YAML is reported per file.
Fields§
§title: Option<String>Page title; falls back to filename stem when absent.
date: Option<String>Optional publication date string (opaque to the engine).
Taxonomy tags rendered in the layout when present.
draft: boolWhen true, the page is skipped during compilation.
layout: Option<String>Optional layout override relative to the template directory.
description: Option<String>Arbitrary string metadata preserved for template helpers.
Implementations§
Source§impl FrontMatter
impl FrontMatter
Sourcepub fn effective_title(&self, fallback: &str) -> String
pub fn effective_title(&self, fallback: &str) -> String
Returns the effective title, using fallback when none was declared.
Trait Implementations§
Source§impl Clone for FrontMatter
impl Clone for FrontMatter
Source§fn clone(&self) -> FrontMatter
fn clone(&self) -> FrontMatter
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for FrontMatter
impl Debug for FrontMatter
Source§impl Default for FrontMatter
impl Default for FrontMatter
Source§fn default() -> FrontMatter
fn default() -> FrontMatter
Returns the “default value” for a type. Read more
Source§impl<'de> Deserialize<'de> for FrontMatter
impl<'de> Deserialize<'de> for FrontMatter
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl Eq for FrontMatter
Source§impl PartialEq for FrontMatter
impl PartialEq for FrontMatter
impl StructuralPartialEq for FrontMatter
Auto Trait Implementations§
impl Freeze for FrontMatter
impl RefUnwindSafe for FrontMatter
impl Send for FrontMatter
impl Sync for FrontMatter
impl Unpin for FrontMatter
impl UnsafeUnpin for FrontMatter
impl UnwindSafe for FrontMatter
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key and return true if they are equal.Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more