Struct Payload 

pub struct Payload { /* private fields */ }

Ordered, comment-preserving payload of a card-yaml block: a read view onto card-yaml storage.

Contains the block’s $ entries, user fields, and comments interleaved in source order. See the module docs for the full design.

Mutation is crate-internal. The invariants an edit must hold — at most one $quill / $kind / $ext / $seed, no duplicate field keys, every field name matching [A-Za-z_][A-Za-z0-9_]* — are not all expressible in the mutators’ signatures, so out-of-crate authoring goes through the verbs that do enforce them: Card::store_field / store_ext / store_seed_overlay, Document::set_quill_ref, and TypedWriter.

Implementations

impl Payload

pub fn items(&self) -> &[PayloadItem]

Ordered iterator over raw items ($ entries, fields, comments).

pub fn quill(&self) -> Option<&QuillReference>

The $quill reference, if declared.

pub fn kind(&self) -> Option<&str>

The $kind value, if declared.

pub fn ext(&self) -> Option<&JsonMap<String, JsonValue>>

The $ext map, if declared. The map is opaque: Quillmark does not interpret its contents and never emits them into the plate JSON.

pub fn seed(&self) -> Option<&JsonMap<String, JsonValue>>

The raw $seed map (keyed by card-kind), if declared. The seeding layer interprets it; it never reaches the plate JSON. For a parsed, per-kind overlay, index this map by kind and pass the entry to crate::SeedOverlay::from_json.

pub fn iter(&self) -> impl Iterator<Item = (&String, &QuillValue)> + '_

Iterator over user (key, &value) pairs. Excludes $ entries and comments; preserves source order.

pub fn keys(&self) -> impl Iterator<Item = &String> + '_

Iterator over user field keys.

pub fn len(&self) -> usize

Number of user-field items ($ entries and comments excluded).

pub fn is_empty(&self) -> bool

true when there are no user-field items.

pub fn get(&self, key: &str) -> Option<&QuillValue>

Look up a user-field value by key. $ entries are not visible via this accessor: use quill / kind / ext / seed.

pub fn contains_key(&self, key: &str) -> bool

true if a user field with this key is present.

pub fn is_fill(&self, key: &str) -> bool

true if a user field with this key is marked !must_fill.

pub fn to_index_map(&self) -> IndexMap<String, QuillValue>

Project the user-field portion into an IndexMap<String, QuillValue>. Comments, fill markers, and $ entries are dropped. Preserves order.

Trait Implementations

impl Clone for Payload

fn clone(&self) -> Payload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Payload

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

Formats the value using the given formatter.

impl From<&Payload> for PayloadV0_92_0

fn from(payload: &Payload) -> Self

Converts to this type from the input type.

impl<'a> IntoIterator for &'a Payload

type Item = (&'a String, &'a QuillValue)

The type of the elements being iterated over.

type IntoIter = FilterMap<Iter<'a, PayloadItem>, fn(&'a PayloadItem) -> Option<(&'a String, &'a QuillValue)>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Payload

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Payload

impl TryFrom<PayloadV0_92_0> for Payload

type Error = StorageError

The type returned in the event of a conversion error.

fn try_from(p: PayloadV0_92_0) -> Result<Self, Self::Error>

Performs the conversion.