Enum Envelope 

pub enum Envelope<T> {
    Success {
        version: String,
        data: T,
    },
    Failure {
        version: String,
        error: OpError,
    },
}

sc-ai-cli response envelope.

Success carries data and writes error as JSON null. Failure carries OpError and writes data as JSON null. Constructors stamp ENVELOPE_VERSION. Deserialization keeps the version string from the input. An ok flag that disagrees with the other field, or an object that does not have exactly the four keys, is rejected with DISCRIMINANT_CODE in the error.

Variants

Success

ok is true and data is T.

Fields

version: String

Contract version read or written for this value.

data: T

Successful payload. JSON null is a valid T such as () or None.

Failure

ok is false and error is the operation error.

Fields

version: String

Contract version read or written for this value.

error: OpError

Operation error.

Implementations

impl<T> Envelope<T>

pub fn success(data: T) -> Self

Builds a success envelope at ENVELOPE_VERSION.

pub fn failure(error: OpError) -> Self

Builds a failure envelope at ENVELOPE_VERSION.

pub fn version(&self) -> &str

Contract version stored on this value.

pub fn is_ok(&self) -> bool

Reports whether this value is the success case.

pub fn data(&self) -> Option<&T>

Returns the payload when this value is the success case.

pub fn error(&self) -> Option<&OpError>

Returns the error when this value is the failure case.

pub fn into_result(self) -> Result<T, OpError>

Consumes the envelope and returns the success payload or the operation error.

version is not part of the result. A caller that still needs the contract version reads version before calling this method.

Errors

Returns Err when the envelope is the failure case. The error is the OpError the envelope carried.

Examples

use sc_command::Envelope;

let envelope = Envelope::success("ready");
assert_eq!(envelope.into_result(), Ok("ready"));

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: DeserializeOwned,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<Result<T, OpError>> for Envelope<T>

fn from(result: Result<T, OpError>) -> Self

Converts to this type from the input type.

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,

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>