Struct SeedOverlay 

pub struct SeedOverlay {
    pub fields: IndexMap<String, QuillValue>,
    pub body: Option<String>,
}

A parsed, per-kind seed overlay: the sparse fields (and optional body) a newly-added card of a given kind starts with. Built from a $seed[<kind>] entry of the main card’s Card::seed map via SeedOverlay::from_json, and layered over the quill’s schema-example seed by crate::Quill::seed_card (overlay › example › absent). The reserved inner key $body carries the body override; every other user field becomes an entry, while any other $-prefixed key is reserved and dropped.

Fields

fields: IndexMap<String, QuillValue>

Field-value overrides, keyed by field name.

body: Option<String>

Body override, when the overlay declares a $body string.

Implementations

impl SeedOverlay

pub fn from_json(value: &Value) -> Option<Self>

Parse an overlay from a $seed[<kind>] JSON value, or None when it is not a mapping. Use this to turn the raw overlay object a consumer reads from the main card’s $seed map (Card::seed) into a typed overlay to hand to crate::Quill::seed_card — e.g. doc.main().seed().and_then(|m| m.get(kind)).and_then(SeedOverlay::from_json).

Trait Implementations

impl Clone for SeedOverlay

fn clone(&self) -> SeedOverlay

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SeedOverlay

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

Formats the value using the given formatter.

impl Default for SeedOverlay

fn default() -> SeedOverlay

Returns the “default value” for a type.

impl PartialEq for SeedOverlay

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SeedOverlay