Enum casperlabs_contract_ffi::contract_api::Error

pub enum Error {
    None,
    MissingArgument,
    InvalidArgument,
    Deserialize,
    Read,
    ValueNotFound,
    ContractNotFound,
    GetKey,
    UnexpectedKeyVariant,
    UnexpectedValueVariant,
    UnexpectedContractRefVariant,
    InvalidPurseName,
    InvalidPurse,
    UpgradeContractAtURef,
    Transfer,
    NoAccessRights,
    ValueConversion,
    CLTypeMismatch,
    EarlyEndOfStream,
    FormattingError,
    LeftOverBytes,
    OutOfMemoryError,
    MaxKeysLimit,
    DuplicateKey,
    PermissionDenied,
    MissingKey,
    ThresholdViolation,
    KeyManagementThresholdError,
    DeploymentThresholdError,
    PermissionDeniedError,
    InsufficientTotalWeight,
    InvalidSystemContract,
    PurseNotCreated,
    Unhandled,
    BufferTooSmall,
    HostBufferEmpty,
    HostBufferFull,
    Mint(u8),
    ProofOfStake(u8),
    User(u16),
}

Variants to be passed to runtime::revert().

Variants other than Error::User will represent a u32 in the range (0, u16::MAX], while Error::User will represent a u32 in the range (u16::MAX, 2 * u16::MAX + 1].

Users can specify a C-style enum and implement From to ease usage of runtime::revert(), e.g.

use casperlabs_contract_ffi::contract_api::Error;

#[repr(u16)]
enum FailureCode {
    Zero = 0,  // 65,536 as an Error::User
    One,       // 65,537 as an Error::User
    Two        // 65,538 as an Error::User
}

impl From<FailureCode> for Error {
    fn from(code: FailureCode) -> Self {
        Error::User(code as u16)
    }
}

assert_eq!(Error::User(1), FailureCode::One.into());
assert_eq!(65_536, u32::from(Error::from(FailureCode::Zero)));
assert_eq!(65_538, u32::from(Error::from(FailureCode::Two)));

Variants

None

Optional data was unexpectedly None.

MissingArgument

Specified argument not provided.

InvalidArgument

Argument not of correct type.

Deserialize

Failed to deserialize a value.

Read

read returned an error.

ValueNotFound

The given key returned a None value.

ContractNotFound

Failed to find a specified contract.

GetKey

A call to get_key() returned a failure.

UnexpectedKeyVariant

The Key variant was not as expected.

UnexpectedValueVariant

The Value variant was not as expected.

UnexpectedContractRefVariant

The ContractRef variant was not as expected.

InvalidPurseName

Invalid purse name given.

InvalidPurse

Invalid purse retrieved.

UpgradeContractAtURef

Failed to upgrade contract at URef.

Transfer

Failed to transfer motes.

NoAccessRights

No access rights.

ValueConversion

A given type could be derived from a Value.

CLTypeMismatch

A given type could be derived from a CLValue.

EarlyEndOfStream

Early end of stream when deserializing.

FormattingError

Formatting error.

LeftOverBytes

Leftover bytes.

OutOfMemoryError

Out of memory error.

MaxKeysLimit

Unable to add new associated key because maximum amount of keys is reached.

DuplicateKey

Unable to add new associated key because given key already exists.

PermissionDenied

Unable to add/update/remove new associated key due to insufficient permissions.

MissingKey

Unable to update/remove a key that does exist.

ThresholdViolation

Unable to update/remove a key which would violate action threshold constraints.

KeyManagementThresholdError

New threshold should be lower or equal than deployment threshold.

DeploymentThresholdError

New threshold should be lower or equal than key management threshold.

PermissionDeniedError

Unable to set action threshold due to insufficient permissions.

InsufficientTotalWeight

New threshold should be lower or equal than total weight of associated keys.

InvalidSystemContract

Returns when contract tries to obtain URef to a system contract that does not exist.

PurseNotCreated

Failed to create a new purse.

Unhandled

An unhandled value, likely representing a bug in the code.

BufferTooSmall

Passing a buffer of a size that is too small to complete an operation

HostBufferEmpty

No data available in the host buffer.

HostBufferFull

Data in the host buffer is full and should be consumed first by read operation

Mint(u8)

Error specific to Mint contract.

ProofOfStake(u8)

Error specific to Proof of Stake contract.

User(u16)

User-specified value. The internal u16 value is added to u16::MAX as u32 + 1 when an Error::User is converted to a u32.

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 Copy for Error

impl Debug for Error

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

Formats the value using the given formatter.

impl Eq for Error

impl From<AddKeyFailure> for Error

fn from(error: AddKeyFailure) -> Self

Performs the conversion.

impl From<CLValueError> for Error

fn from(error: CLValueError) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(error: Error) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(error: Error) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(error: Error) -> Self

Performs the conversion.

impl From<Error> for u32

fn from(error: Error) -> Self

Performs the conversion.

impl From<RemoveKeyFailure> for Error

fn from(error: RemoveKeyFailure) -> Self

Performs the conversion.

impl From<SetThresholdFailure> for Error

fn from(error: SetThresholdFailure) -> Self

Performs the conversion.

impl From<UpdateKeyFailure> for Error

fn from(error: UpdateKeyFailure) -> Self

Performs the conversion.

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 StructuralEq for Error

impl StructuralPartialEq for Error