Enum cosmwasm_std::ContractResult

pub enum ContractResult<S> {
    Ok(S),
    Err(String),
}

This is the final result type that is created and serialized in a contract for every init/execute/migrate call. The VM then deserializes this type to distinguish between successful and failed executions.

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.

Examples

Success:

let response: Response = Response::default();
let result: ContractResult<Response> = ContractResult::Ok(response);
assert_eq!(to_vec(&result).unwrap(), br#"{"ok":{"messages":[],"attributes":[],"events":[],"data":null}}"#.to_vec());

Failure:

let error_msg = String::from("Something went wrong");
let result: ContractResult<Response> = ContractResult::Err(error_msg);
assert_eq!(to_vec(&result).unwrap(), br#"{"error":"Something went wrong"}"#.to_vec());

Variants

Ok(S)

Tuple Fields of Ok

0: S

Err(String)

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

Tuple Fields of Err

0: String

Implementations

impl<S> ContractResult<S>

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

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

pub fn unwrap(self) -> S

pub fn is_ok(&self) -> bool

pub fn is_err(&self) -> bool

impl<S: Debug> ContractResult<S>

pub fn unwrap_err(self) -> String

Trait Implementations

impl<S: Clone> Clone for ContractResult<S>

fn clone(&self) -> ContractResult<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for ContractResult<S>

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

Formats the value using the given formatter.

impl<'de, S> Deserialize<'de> for ContractResult<S> where
    S: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<S> From<ContractResult<S>> for Result<S, String>

fn from(original: ContractResult<S>) -> Result<S, String>

Performs the conversion.

impl<S, E: ToString> From<Result<S, E>> for ContractResult<S>

fn from(original: Result<S, E>) -> ContractResult<S>

Performs the conversion.

impl<S: JsonSchema> JsonSchema for ContractResult<S>

fn schema_name() -> String

The name of the generated JSON Schema.

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<S: PartialEq> PartialEq<ContractResult<S>> for ContractResult<S>

fn eq(&self, other: &ContractResult<S>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ContractResult<S>) -> bool

This method tests for !=.

impl<S> Serialize for ContractResult<S> where
    S: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<S> StructuralPartialEq for ContractResult<S>