Struct MetadataFieldDef 

pub struct MetadataFieldDef {
    pub key: String,
    pub description: String,
    pub field_type: FieldType,
    pub default_value: Option<String>,
    pub enum_values: Option<Vec<String>>,
    pub required: Option<bool>,
    pub legacy_optional: Option<bool>,
    pub required_resolved: bool,
    pub init_timestamp: bool,
    pub auto_timestamp: bool,
    pub serialization: Serialization,
    pub filterable: Filterable,
}

A metadata (frontmatter) field.

Fields

key: String

description: String

field_type: FieldType

default_value: Option<String>

enum_values: Option<Vec<String>>

required: Option<bool>

Whether an entity must carry this field — absence means optional, the same rule sections follow. required: true refuses a create that leaves the field unset (REQUIRED_FIELD_UNSET); a required field with a default_value (or an init_timestamp) is auto-filled and therefore never refused — required-with-default means “always present”, not “caller must type it”. Replaces the retired optional: key (opposite polarity): sealed schemas carrying optional keep loading with inverted-but-equivalent semantics; authoring refuses it naming this key.

legacy_optional: Option<bool>

The retired optional: key, captured raw so sealed content keeps loading (inverted) while authoring refuses it. Never serialized, never part of the authoring language.

required_resolved: bool

Resolved requiredness — computed at load from required, the retired optional, and the package’s format generation (an unmarked sealed package reads absence as required, the legacy meaning; everything else reads absence as optional). Read via Self::is_required; never parsed from YAML.

init_timestamp: bool

auto_timestamp: bool

serialization: Serialization

filterable: Filterable

Implementations

impl MetadataFieldDef

pub fn is_required(&self) -> bool

Whether an entity must carry this field, after the load-time polarity resolution. The single read every validator and projection uses — required/legacy_optional are raw parse captures, not behaviour.

Trait Implementations

impl Clone for MetadataFieldDef

fn clone(&self) -> MetadataFieldDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetadataFieldDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MetadataFieldDef

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for MetadataFieldDef

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for MetadataFieldDef

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.