Struct Envelope 

pub struct Envelope<'a, T: Serialize> {
    pub schema_version: &'static str,
    pub command: &'a str,
    pub status: &'static str,
    pub data: Option<T>,
    pub error: Option<ErrorEnvelope>,
    pub warnings: Option<Vec<String>>,
}

Top-level JSON envelope written to stdout in JSON mode.

Successful runs SHALL omit the error field; failed runs SHALL omit the data field. Both omissions are achieved through serde’s skip_serializing_if = "Option::is_none".

Fields

schema_version: &'static str

Stable schema version (semver-style).

command: &'a str

Command name (e.g. "match", "sync", "convert").

status: &'static str

Either "ok" or "error".

data: Option<T>

Command-specific payload. Omitted when status == "error".

error: Option<ErrorEnvelope>

Error envelope. Omitted when status == "ok".

warnings: Option<Vec<String>>

Optional non-fatal warnings.

Trait Implementations

impl<'a, T: Debug + Serialize> Debug for Envelope<'a, T>

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

Formats the value using the given formatter.

impl<'a, T> Serialize for Envelope<'a, T>

where T: Serialize + Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.