Skip to main content

FrontmatterFieldJson

Struct FrontmatterFieldJson 

Source
pub struct FrontmatterFieldJson {
    pub name: &'static str,
    pub field_type: &'static str,
    pub widget: &'static str,
    pub default: Option<&'static str>,
    pub enum_values: Option<&'static [&'static str]>,
    pub description: &'static str,
    pub group: &'static str,
    pub skip_schema: bool,
}
Expand description

JSON representation of a single builtin frontmatter field, as surfaced in DescribePayload::frontmatter.

Fields§

§name: &'static str

Field name as it appears in YAML frontmatter (e.g. "children_style").

§field_type: &'static str

Data type string (e.g. "string", "boolean", "integer", "array", "object", "one_of").

§widget: &'static str

UI widget hint (e.g. "select", "text-input", "checkbox").

§default: Option<&'static str>

Default value as a raw JSON literal (e.g. "true", "\"list\""). null when no default is defined.

§enum_values: Option<&'static [&'static str]>

Allowed values for select / enum fields. null for non-enum fields.

§description: &'static str

Human-readable description of the field.

§group: &'static str

UI group name for the add-property dropdown (e.g. "Common", "Children"). Empty string for skip_schema (internal) fields.

§skip_schema: bool

When true, the field is internal to the build pipeline and is not exposed in the editor form or validation schema. Theme authors and content authors can ignore these fields; they are included here for tooling completeness.

Trait Implementations§

Source§

impl Serialize for FrontmatterFieldJson

Source§

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§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.