Enum DirectiveJson 

pub enum DirectiveJson {
    Transaction {
        date: String,
        flag: String,
        payee: Option<String>,
        narration: Option<String>,
        tags: Vec<String>,
        links: Vec<String>,
        postings: Vec<PostingJson>,
        meta: HashMap<String, MetaValueJson>,
    },
    Balance {
        date: String,
        account: String,
        amount: AmountValue,
        tolerance: Option<String>,
        meta: HashMap<String, MetaValueJson>,
    },
    Open {
        date: String,
        account: String,
        currencies: Vec<String>,
        booking: Option<String>,
        meta: HashMap<String, MetaValueJson>,
    },
    Close {
        date: String,
        account: String,
        meta: HashMap<String, MetaValueJson>,
    },
    Commodity {
        date: String,
        currency: String,
        meta: HashMap<String, MetaValueJson>,
    },
    Pad {
        date: String,
        account: String,
        source_account: String,
        meta: HashMap<String, MetaValueJson>,
    },
    Event {
        date: String,
        event_type: String,
        value: String,
        meta: HashMap<String, MetaValueJson>,
    },
    Note {
        date: String,
        account: String,
        comment: String,
        meta: HashMap<String, MetaValueJson>,
    },
    Document {
        date: String,
        account: String,
        path: String,
        tags: Vec<String>,
        links: Vec<String>,
        meta: HashMap<String, MetaValueJson>,
    },
    Price {
        date: String,
        currency: String,
        amount: AmountValue,
        meta: HashMap<String, MetaValueJson>,
    },
    Query {
        date: String,
        name: String,
        query_string: String,
        meta: HashMap<String, MetaValueJson>,
    },
    Custom {
        date: String,
        custom_type: String,
        values: Vec<TypedValueJson>,
        meta: HashMap<String, MetaValueJson>,
    },
}

A directive in JSON-serializable form.

Each variant corresponds to a Beancount directive type, with fields representing the directive’s data in a JavaScript-friendly format.

All variants carry a meta field with user-defined key/value metadata from the source (issue #1168). Empty metadata serializes as an absent field, so existing consumers continue to see the pre-#1168 shape on directives without explicit metadata.

Variants

Transaction

Transaction directive.

Fields

date: String

flag: String

payee: Option<String>

Optional payee. Mirrors FFI-WASI’s shape: absent on the wire when None (closes #1221).

narration: Option<String>

Optional narration. Empty narrations are normalized to None in convert.rs so the field is absent on the wire in the empty case – matches FFI-WASI’s pattern (#1221).

tags: Vec<String>

links: Vec<String>

postings: Vec<PostingJson>

meta: HashMap<String, MetaValueJson>

Balance

Balance assertion.

Fields

date: String

account: String

amount: AmountValue

tolerance: Option<String>

Explicit tolerance from the ~ 0.01 annotation, stringified. Mirrors rustledger_core::Balance::tolerance.

meta: HashMap<String, MetaValueJson>

Open

Open account.

Fields

date: String

account: String

currencies: Vec<String>

booking: Option<String>

meta: HashMap<String, MetaValueJson>

Close

Close account.

Fields

date: String

account: String

meta: HashMap<String, MetaValueJson>

Commodity

Commodity declaration.

Fields

date: String

currency: String

meta: HashMap<String, MetaValueJson>

Pad

Pad directive.

Fields

date: String

account: String

source_account: String

meta: HashMap<String, MetaValueJson>

Event

Event directive.

Fields

date: String

event_type: String

value: String

meta: HashMap<String, MetaValueJson>

Note

Note directive.

Fields

date: String

account: String

comment: String

meta: HashMap<String, MetaValueJson>

Document

Document directive.

Fields

date: String

account: String

path: String

tags: Vec<String>

Tags attached to the document directive (issue #1144).

links: Vec<String>

Links attached to the document directive (issue #1144).

meta: HashMap<String, MetaValueJson>

Price

Price directive.

Fields

date: String

currency: String

amount: AmountValue

meta: HashMap<String, MetaValueJson>

Query

Query directive.

Fields

date: String

name: String

query_string: String

meta: HashMap<String, MetaValueJson>

Custom

Custom directive.

values carries the positional arguments after the type keyword. Each value is a TypedValueJson tagged union ({type, value}) that preserves the host MetaValue variant tag, so JS consumers can distinguish (for example) a Date from a String from an Account — all of which would otherwise collapse to bare JSON strings under the untagged MetaValueJson shape.

Pre-#1168: values was dropped entirely from the JSON output. Pre-#1207: present but emitted raw via MetaValueJson (lossy). Post-#1207: emitted via TypedValueJson (this variant), mirroring FFI-WASI’s Vec<TypedValue>.

Both values and meta use skip_serializing_if to omit the field when empty (consistent shape: a Custom directive with no positional args and no metadata serializes as {type, date, custom_type}, matching what the TS shape declares via values? / meta?).

Fields

date: String

custom_type: String

values: Vec<TypedValueJson>

Positional values after the custom TYPE keyword. Each entry is a TypedValueJson ({type, value}) — the tagged shape preserves the host MetaValue variant tag so JS consumers can distinguish a Date from a String from an Account (closes #1207). Mirrors FFI-WASI’s Vec<TypedValue> exactly.

meta: HashMap<String, MetaValueJson>

Implementations

impl DirectiveJson

pub fn meta(&self) -> &HashMap<String, MetaValueJson>

Return the metadata map for this directive, regardless of which variant it is.

Every variant carries a meta field but the per-variant destructure pattern means call sites that want to read meta generically need a 12-arm match. This accessor centralizes that match so callers don’t reimplement it (and so adding a future variant fails compilation here, not at every call site).

Rust-only API: not exposed to JavaScript via #[wasm_bindgen]. JS consumers read directive.meta directly off the serialized object — meta() only serves Rust callers (tests in this crate; downstream Rust crates that consume the WASM-crate types directly).

Trait Implementations

impl Clone for DirectiveJson

fn clone(&self) -> DirectiveJson

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DirectiveJson

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DirectiveJson

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DirectiveJson

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

where __S: Serializer,

Serialize this value into the given Serde serializer.