Struct exonum::runtime::error::ExecutionError

pub struct ExecutionError {
    pub kind: ErrorKind,
    pub description: String,
}

Result of unsuccessful runtime execution.

An execution error consists of an error kind and optional description. The error code affects the blockchain state hash, while the description does not. Therefore descriptions are mostly used for developer purposes, not for interaction of the system with users.

Usually you can implement conversion from your own error type to the ExecutionError via deriving IntoExecutionError from exonum-derive crate.

This macro implements From<MyError> for ExecutionError conversion for the given enum. Enumeration should have an explicit discriminant for each error kind. Derives Display and Fail traits using documentation comments for each error kind.

Examples

Deriving errors in service transactions:

use exonum_derive::IntoExecutionError;

/// Error codes emitted by wallet transactions during execution:
#[derive(Debug, IntoExecutionError)]
pub enum Error {
    /// Content hash already exists.
    HashAlreadyExists = 0,
    /// Unable to parse the service configuration.
    ConfigParseError = 1,
    /// Time service with the specified name does not exist.
    TimeServiceNotFound = 2,
}

Deriving errors in runtimes:

use exonum_derive::IntoExecutionError;

// Define runtime specific errors.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, IntoExecutionError)]
#[execution_error(kind = "runtime")]
enum SampleRuntimeError {
    /// Incorrect information to call the transaction.
    IncorrectCallInfo = 1,
    /// Incorrect transaction payload.
    IncorrectPayload = 2,
}

Fields

kind: ErrorKind

The kind of error that indicates in which module and with which code the error occurred.

description: String

Optional description which doesn't affect object_hash.

Methods

impl ExecutionError

pub fn new(kind: ErrorKind, description: impl Into<String>) -> Self

Creates a new execution error instance with the specified error kind and an optional description.

Trait Implementations

impl From<Error> for ExecutionError

fn from(inner: Error) -> Self

Performs the conversion.

impl<E, T> From<(E, T)> for ExecutionError where
    T: Display,
    E: Into<ErrorKind>, 

fn from(inner: (E, T)) -> Self

Performs the conversion.

impl From<Error> for ExecutionError

fn from(inner: Error) -> Self

Performs the conversion.

impl Clone for ExecutionError

fn clone(&self) -> ExecutionError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for ExecutionError

impl Ord for ExecutionError

fn cmp(&self, other: &ExecutionError) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<ExecutionError> for ExecutionError

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

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

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

This method tests for !=.

impl PartialOrd<ExecutionError> for ExecutionError

fn partial_cmp(&self, other: &ExecutionError) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &ExecutionError) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &ExecutionError) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &ExecutionError) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &ExecutionError) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Debug for ExecutionError

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

Formats the value using the given formatter.

impl Display for ExecutionError

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

Formats the value using the given formatter.

impl Hash for ExecutionError

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl StructuralPartialEq for ExecutionError

impl StructuralEq for ExecutionError

impl Fail for ExecutionError

fn name(&self) -> Option<&str>

Returns the "name" of the error.

fn cause(&self) -> Option<&dyn Fail>

Returns a reference to the underlying cause of this failure, if it is an error that wraps other errors.

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

Returns a reference to the Backtrace carried by this failure, if it carries one.

fn context<D>(self, context: D) -> Context<D> where
    D: Display + Send + Sync + 'static, 

Provides context for this failure.

fn compat(self) -> Compat<Self>

Wraps this failure in a compatibility wrapper that implements std::error::Error.

impl BinaryValue for ExecutionError

fn to_bytes(&self) -> Vec<u8>

Serializes the given value to the vector of bytes.

fn from_bytes(value: Cow<[u8]>) -> Result<Self, Error>

Deserializes the value from the given bytes array.

fn into_bytes(self) -> Vec<u8>

Consumes and serializes the given value to the vector of bytes. This method is faster with the wrapped values, thus if you wouldn't use value after serialization use it.

impl ObjectHash for ExecutionError

fn object_hash(&self) -> Hash

Returns a hash of the value.

impl ProtobufConvert for ExecutionError

type ProtoStruct = ExecutionError

Type of the protobuf clone of Self

fn to_pb(&self) -> Self::ProtoStruct

Struct -> ProtoStruct

fn from_pb(pb: Self::ProtoStruct) -> Result<Self, Error>

ProtoStruct -> Struct