Enum cosmwasm_std::StdError

pub enum StdError {
    GenericErr {
        msg: String,
    },
    InvalidBase64 {
        msg: String,
    },
    InvalidDataSize {
        expected: u64,
        actual: u64,
    },
    InvalidUtf8 {
        msg: String,
    },
    NotFound {
        kind: String,
    },
    ParseErr {
        target_type: String,
        msg: String,
    },
    SerializeErr {
        source_type: String,
        msg: String,
    },
    Underflow {
        minuend: String,
        subtrahend: String,
    },
}

Structured error type for init, handle and query.

This can be serialized and passed over the Wasm/VM boundary, which allows us to use structured error types in e.g. integration tests. In that process backtraces are stripped off.

The prefix "Std" means "the standard error within the standard library". This is not the only result/error type in cosmwasm-std.

When new cases are added, they should describe the problem rather than what was attempted (e.g. InvalidBase64 is preferred over Base64DecodingErr). In the long run this allows us to get rid of the duplication in "StdError::FooErr".

Checklist for adding a new error:

• Add enum case
• Add creator function in std_error_helpers.rs

Variants

GenericErr

Whenever there is no specific error type available

Fields of GenericErr

msg: String

InvalidBase64

Fields of InvalidBase64

msg: String

InvalidDataSize

Fields of InvalidDataSize

expected: u64actual: u64

InvalidUtf8

Whenever UTF-8 bytes cannot be decoded into a unicode string, e.g. in String::from_utf8 or str::from_utf8.

Fields of InvalidUtf8

msg: String

NotFound

Fields of NotFound

kind: String

ParseErr

Fields of ParseErr

target_type: String

the target type that was attempted

msg: String

SerializeErr

Fields of SerializeErr

source_type: String

the source type that was attempted

msg: String

Underflow

Fields of Underflow

minuend: Stringsubtrahend: String

Implementations

impl StdError

pub fn generic_err<S: Into<String>>(msg: S) -> Self

pub fn invalid_base64<S: ToString>(msg: S) -> Self

pub fn invalid_data_size(expected: usize, actual: usize) -> Self

pub fn invalid_utf8<S: ToString>(msg: S) -> Self

pub fn not_found<S: Into<String>>(kind: S) -> Self

pub fn parse_err<T: Into<String>, M: ToString>(target: T, msg: M) -> Self

pub fn serialize_err<S: Into<String>, M: ToString>(source: S, msg: M) -> Self

pub fn underflow<U: ToString>(minuend: U, subtrahend: U) -> Self

Trait Implementations

impl Debug for StdError

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

Formats the value using the given formatter.

impl Display for StdError

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

Formats the value using the given formatter.

impl Error for StdError

pub fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

pub fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

pub fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<FromUtf8Error> for StdError

pub fn from(source: FromUtf8Error) -> Self

Performs the conversion.

impl From<Utf8Error> for StdError

pub fn from(source: Utf8Error) -> Self

Performs the conversion.

impl PartialEq<StdError> for StdError

pub fn eq(&self, rhs: &StdError) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.