Struct CardWire 

#[non_exhaustive]
pub struct CardWire {
    pub kind: String,
    pub quill: Option<String>,
    pub id: Option<String>,
    pub ext: Option<Map<String, Value>>,
    pub seed: Option<Map<String, Value>>,
    pub payload_items: Vec<PayloadItemWire>,
    pub body: Value,
}

Canonical live wire form of a Card. See the module docs.

Serializes to JS-facing camelCase (payloadItems); the snake_case payload_items is also accepted on input for the Python binding. deny_unknown_fields makes a stale flat { kind, fields } shape fail loudly rather than deserialize into an empty card.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

kind: String

The block’s $kind (e.g. "endorsement"); empty string when the block declares no $kind. Kept non-optional to match the binding read shape.

quill: Option<String>

The block’s $quill reference string (name@version), present on the main card only. Omitted when absent.

id: Option<String>

The block’s $id, if any. Omitted when absent.

ext: Option<Map<String, Value>>

The block’s opaque $ext map, if declared. Omitted when absent.

seed: Option<Map<String, Value>>

The block’s $seed map (keyed by card-kind), if declared. Present on the main card only. Omitted when absent.

payload_items: Vec<PayloadItemWire>

User fields and comments, in source order.

body: Value

The card body as canonical Content-JSON: the source-of-truth content model (a content object, {text, lines, marks, islands}). The empty content when absent. A markdown string is also accepted on input (imported), so an LLM/markdown writer can hand a string here.

No body_markdown projection rides this wire. Delimiter safety makes to_markdown re-parse every rendered line, so an eager export ∘ body precompute is not cheap; the exportMarkdown(body) codec at the binding boundary does it on demand instead.

Implementations

impl CardWire

pub fn new(kind: String, body: JsonValue) -> Self

A card block with no $-prefixed system metadata. kind is the empty string for a block declaring none. body is canonical Content-JSON, or a markdown string the reader imports.

Trait Implementations

impl Clone for CardWire

fn clone(&self) -> CardWire

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CardWire

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CardWire

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Card> for CardWire

fn from(card: &Card) -> Self

Converts to this type from the input type.

impl PartialEq for CardWire

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CardWire

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CardWire

impl TryFrom<CardWire> for Card

type Error = WireError

The type returned in the event of a conversion error.

fn try_from(wire: CardWire) -> Result<Self, Self::Error>

Performs the conversion.