[−][src]Struct mercurius::FrontMatter
The frontmatter in a Markdown file.
Note, mercurius only parses the frontmatter, it would never modify the parsing result itself. Functionalities below is implemented by another binary package named quatrain.
Fields
title: String
The title of the current file.
HTML Rendering
- Title would be used in the
<title>
tag. - It would also be prepended as an
<h1>
at the front of the article.
create_date: ReadableDate
The create date of the file.
This should be the exact date the file was created, even empty.
last_update: Option<ReadableDate>
The last modified date of the file.
Formatting or rewriting should not be taken into account.
HTML Render
- This field is now used to calculate the Outdate Info.
lang: Lang
Main language of the file.
This language should be the one used most in this file. Use the word Apple
to
refer that language, e.g., 林檎
.
description: Option<String>
The description of the file.
Currently this field will not be used in any place. This is reserved for future usage,
e.g., the <meta>
tag.
Tagging the file.
Currently this field will not be used in any place. This is reserved for future usage, e.g., filtering by tags.
status: Status
The status of the file.
Currently this field will not be used in any place. This is reserved for future usage, e.g., conditional rendering or publishing.
render: Render
Control the rendering behavior.
The banner of the file.
Trait Implementations
impl Clone for FrontMatter
[src]
fn clone(&self) -> FrontMatter
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for FrontMatter
[src]
impl Default for FrontMatter
[src]
fn default() -> FrontMatter
[src]
impl<'de> Deserialize<'de> for FrontMatter
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl PartialEq<FrontMatter> for FrontMatter
[src]
fn eq(&self, other: &FrontMatter) -> bool
[src]
fn ne(&self, other: &FrontMatter) -> bool
[src]
impl Serialize for FrontMatter
[src]
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl StructuralPartialEq for FrontMatter
[src]
Auto Trait Implementations
impl RefUnwindSafe for FrontMatter
impl Send for FrontMatter
impl Sync for FrontMatter
impl Unpin for FrontMatter
impl UnwindSafe for FrontMatter
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,