Enum ark_api::Error

pub enum Error {
    ApiNotAvailable,
    Internal,
    InvalidArguments,
    NotFound,
    Unavailable,
    Other(u32),
}

API error enum, describes how an Ark API call can fail

This is a more ergonomic version of the Ark API FFI ErrorCode value as this can only contain errors, not success and it implements std::error::Error to be able to be used in std::result::Result

Variants

ApiNotAvailable

API not available.

Typically happens if a module calls an API it has not specified that it requires

Internal

Internal error - something went wrong on in the Ark host

InvalidArguments

Invalid arguments - the inputs to the called API function were not valid

NotFound

Resource not found - used by APIs to indicate a requested resource can’t be found

Unavailable

The API or resource is currently not available

Other(u32)

Other unknown error with specific code

This can happen if a newer version of Ark introduces a new type of error

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

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

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

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

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

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<ErrorCode> for Error

fn from(code: ErrorCode) -> Self

Converts to this type from the input type.

impl PartialEq<Error> for Error

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

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

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

This method tests for !=.

impl Copy for Error

impl Eq for Error

impl StructuralEq for Error

impl StructuralPartialEq for Error