Enum Envelope 

pub enum Envelope<T> {
    #[non_exhaustive]
    Ok {
        schema_version: u32,
        data: T,
    },
    #[non_exhaustive]
    Err {
        schema_version: u32,
        error: ErrorBody,
    },
}

A JSON envelope: status is ok with data, or err with error, and both carry schema_version.

Build one with Envelope::ok or Envelope::err. Each variant can gain a field in a minor release, so a pattern outside ctl-core ends with ...

Variants

#[non_exhaustive]

Ok

A success. Serializes with "status": "ok".

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

schema_version: u32

The envelope shape version, SCHEMA_VERSION.

data: T

The command’s result.

#[non_exhaustive]

Err

A failure. Serializes with "status": "err".

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

schema_version: u32

The envelope shape version, SCHEMA_VERSION.

error: ErrorBody

What failed.

Implementations

impl<T> Envelope<T>

pub fn ok(data: T) -> Self

Wrap data in a current-version success envelope.

pub fn err(error: ErrorBody) -> Self

Wrap error in a current-version failure envelope.

Trait Implementations

impl<T: Clone> Clone for Envelope<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Envelope<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Envelope<T>

where T: Deserialize<'de>,

Available on crate feature json only.

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Eq> Eq for Envelope<T>

impl<T> JsonSchema for Envelope<T>

where T: JsonSchema,

Available on crate feature schema only.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl<T: PartialEq> PartialEq for Envelope<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T> Serialize for Envelope<T>

where T: Serialize,

Available on crate feature json only.

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: PartialEq> StructuralPartialEq for Envelope<T>