Frontmatter

typstify_core::frontmatter

Struct Frontmatter

pub struct Frontmatter {Show 13 fields
    pub title: String,
    pub date: Option<DateTime<Utc>>,
    pub updated: Option<DateTime<Utc>>,
    pub draft: bool,
    pub description: Option<String>,
    pub tags: Vec<String>,
    pub categories: Vec<String>,
    pub aliases: Vec<String>,
    pub custom_js: Vec<String>,
    pub custom_css: Vec<String>,
    pub template: Option<String>,
    pub weight: i32,
    pub extra: HashMap<String, Value>,
}

Expand description

Frontmatter metadata for content files.

Fields§

§title: String

Page title (required).

§date: Option<DateTime<Utc>>

Publication date.

§updated: Option<DateTime<Utc>>

Last updated date.

§draft: bool

Whether this is a draft.

§description: Option<String>

Page description for meta tags and summaries.

§tags: Vec<String>

Tags for the page.

§categories: Vec<String>

Categories for the page.

§aliases: Vec<String>

URL aliases for redirects.

§custom_js: Vec<String>

Custom JavaScript files to include.

§custom_css: Vec<String>

Custom CSS files to include.

§template: Option<String>

Template to use for rendering.

§weight: i32

Sort weight for ordering.

§extra: HashMap<String, Value>

Custom extra fields (for extensibility).

Implementations§

impl Frontmatter

pub fn validate(&self, path: &Path) -> Result<()>

Validate required fields.

Trait Implementations§

impl Clone for Frontmatter

fn clone(&self) -> Frontmatter

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Frontmatter

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

Formats the value using the given formatter. Read more

impl Default for Frontmatter

fn default() -> Frontmatter

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for Frontmatter

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for Frontmatter

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl Freeze for Frontmatter

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,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Serialize for T
where T: Serialize + ?Sized,

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where 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>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,