Struct Envelope 

pub struct Envelope<T>
where
    T: Serialize,
{
    pub schema_version: String,
    pub ok: bool,
    pub data: Option<T>,
    pub warnings: Vec<String>,
    pub error: Option<EnvelopeError>,
}

Envelope shared by every JSON-emitting subcommand.

The shape is intentionally narrow: schema_version pins the wire contract, ok is a boolean success flag, data carries the per-subcommand payload, warnings collects non-fatal diagnostics (so JSON consumers see what text mode would print to stderr), and error carries a structured failure.

Fields

schema_version: String

ok: bool

data: Option<T>

warnings: Vec<String>

error: Option<EnvelopeError>

Implementations

impl<T> Envelope<T>

where T: Serialize,

pub fn success(schema_version: impl Into<String>, data: T) -> Envelope<T>

Build a successful envelope.

pub fn failure( schema_version: impl Into<String>, error: EnvelopeError, ) -> Envelope<T>

Build a failure envelope with no payload.

pub fn with_warning(self, warning: impl Into<String>) -> Envelope<T>

Append a single warning to the envelope.

pub fn with_warnings<I, S>(self, warnings: I) -> Envelope<T>

where I: IntoIterator<Item = S>, S: Into<String>,

Append multiple warnings to the envelope.

Trait Implementations

impl<T> Clone for Envelope<T>

where T: Clone + Serialize,

fn clone(&self) -> Envelope<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Envelope<T>

where T: Debug + Serialize,

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

Formats the value using the given formatter.

impl<T> Serialize for Envelope<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.