Struct Envelope 

pub struct Envelope {
    pub api_version: &'static str,
    pub kind: String,
    pub host: String,
    pub status: Status,
    pub data: Option<Value>,
    pub error: Option<ApiError>,
    pub hints: Option<Value>,
}

The machine-readable response wrapper for every command.

Fields

api_version: &'static str

Schema version, always API_VERSION.

kind: String

The payload kind (e.g. ServiceList, Error).

host: String

Host the response pertains to.

status: Status

Whether the operation succeeded.

data: Option<Value>

Success payload, present when status is ok.

error: Option<ApiError>

Error payload, present when status is error.

hints: Option<Value>

Optional machine-actionable hints (e.g. a reverse command).

Implementations

impl Envelope

pub fn ok(kind: &str, host: &str, data: Value) -> Self

Build a success envelope wrapping data.

pub fn error(kind: &str, host: &str, err: ApiError) -> Self

Build an error envelope carrying err.

pub fn with_hints(self, hints: Value) -> Self

Attach machine-actionable hints (e.g. the reversibility hint, Section 8).

pub fn to_json_string(&self) -> String

Serialize the envelope to a pretty-printed JSON string.

Returns a valid fez/v1 error envelope on serialization failure so that callers always receive syntactically correct JSON.

Trait Implementations

impl Serialize for Envelope

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

where __S: Serializer,

Serialize this value into the given Serde serializer.