Enum PayloadItem 

#[non_exhaustive]
pub enum PayloadItem {
    Quill {
        reference: QuillReference,
    },
    Kind {
        value: String,
    },
    Meta {
        key: MetaKey,
        value: Map<String, Value>,
        nested_comments: Vec<NestedComment>,
    },
    Field {
        key: String,
        value: QuillValue,
        fill: bool,
        nested_comments: Vec<NestedComment>,
    },
    Comment {
        text: String,
        inline: bool,
    },
}

One entry in a Payload: a typed $ system metadata entry, a user field, or a comment line.

PayloadItem is the live in-memory model; it is intentionally not Serialize/Deserialize. Storage uses the versioned DTOs in document::dto, and bindings translate to their own wire types.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Quill

$quill system metadata, holding the parsed quill reference.

Fields

reference: QuillReference

Kind

$kind system metadata: the card’s kind name.

Fields

value: String

Meta

$ext / $seed system metadata: an opaque mapping (discriminated by MetaKey) reserved for out-of-band data. Never emitted into the plate JSON, always round-trips through Markdown and the storage DTO. nested_comments carries YAML comments inside the mapping; paths are relative to the value tree (the $ext / $seed key itself is not part of the path). $seed is additionally interpreted by the seeding layer; see crate::SeedOverlay::from_json and crate::Quill::seed_card.

Fields

key: MetaKey

value: Map<String, Value>

nested_comments: Vec<NestedComment>

Field

A user-defined YAML field, optionally tagged !must_fill.

nested_comments carries YAML comments inside the field’s value (only meaningful when the value is a mapping or sequence); paths are relative to the field’s value tree (the field’s key is not part of the path).

Fields

key: String

value: QuillValue

fill: bool

true when the field was written as key: !must_fill <value> or key: !must_fill in source.

nested_comments: Vec<NestedComment>

Comment

A YAML comment. Text excludes the leading # and one optional space.

inline distinguishes own-line comments (# text on a line by itself) from trailing inline comments (field: value # text). An inline comment attaches to the item that immediately precedes it in the items vector; if no such item exists at emit time (orphan) it degrades to an own-line comment.

Fields

text: String

inline: bool

Implementations

impl PayloadItem

pub fn nested_comments(&self) -> &[NestedComment]

Borrow the field/meta nested-comments slice. Returns &[] for variants that don’t carry nested comments.

Trait Implementations

impl Clone for PayloadItem

fn clone(&self) -> PayloadItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PayloadItem

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

Formats the value using the given formatter.

impl From<&PayloadItem> for PayloadItemV0_92_0

fn from(item: &PayloadItem) -> Self

Converts to this type from the input type.

impl PartialEq for PayloadItem

fn eq(&self, other: &PayloadItem) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for PayloadItem

impl TryFrom<PayloadItemV0_92_0> for PayloadItem

type Error = StorageError

The type returned in the event of a conversion error.

fn try_from(item: PayloadItemV0_92_0) -> Result<Self, Self::Error>

Performs the conversion.