Enum SubMsgResult

pub enum SubMsgResult {
    Ok(SubMsgResponse),
    Err(String),
}

This is the result type that is returned from a sub message execution.

We use a custom type here instead of Rust’s Result because we want to be able to define the serialization, which is a public interface. Every language that compiles to Wasm and runs in the ComsWasm VM needs to create the same JSON representation.

Until version 1.0.0-beta5, ContractResult<SubMsgResponse> was used instead of this type. Once serialized, the two types are the same. However, in the Rust type system we want different types for clarity and documentation reasons.

Examples

Success:

#[allow(deprecated)]
let response = SubMsgResponse {
    data: Some(Binary::from_base64("MTIzCg==").unwrap()),
    events: vec![Event::new("wasm").add_attribute("foo", "bar")],
    msg_responses: vec![],
};
let result: SubMsgResult = SubMsgResult::Ok(response);
assert_eq!(
    to_json_string(&result).unwrap(),
    r#"{"ok":{"events":[{"type":"wasm","attributes":[{"key":"foo","value":"bar"}]}],"data":"MTIzCg==","msg_responses":[]}}"#,
);

Failure:

let error_msg = String::from("Something went wrong");
let result = SubMsgResult::Err(error_msg);
assert_eq!(to_json_string(&result).unwrap(), r#"{"error":"Something went wrong"}"#);

Variants

Ok(SubMsgResponse)

Err(String)

An error type that every custom error created by contract developers can be converted to. This could potentially have more structure, but String is the easiest.

Implementations

impl SubMsgResult

pub fn into_result(self) -> Result<SubMsgResponse, String>

Converts a SubMsgResult<S> to a Result<S, String> as a convenient way to access the full Result API.

pub fn unwrap(self) -> SubMsgResponse

pub fn unwrap_err(self) -> String

pub fn is_ok(&self) -> bool

pub fn is_err(&self) -> bool

Trait Implementations

impl Clone for SubMsgResult

fn clone(&self) -> SubMsgResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SubMsgResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SubMsgResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<E: ToString> From<Result<SubMsgResponse, E>> for SubMsgResult

fn from(original: Result<SubMsgResponse, E>) -> SubMsgResult

Converts to this type from the input type.

impl From<SubMsgResult> for Result<SubMsgResponse, String>

fn from(original: SubMsgResult) -> Result<SubMsgResponse, String>

Converts to this type from the input type.

impl JsonSchema for SubMsgResult

fn schema_name() -> String

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(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for SubMsgResult

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SubMsgResult

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SubMsgResult

impl StructuralPartialEq for SubMsgResult