Enum CommandArgumentError

pub enum CommandArgumentError {
    TypeMismatch,
    InvalidBcsBytes,
    InvalidUsageOfPureArgument,
    InvalidArgumentToPrivateEntryFunction,
    IndexOutOfBounds {
        index: u16,
    },
    SecondaryIndexOutOfBounds {
        result: u16,
        subresult: u16,
    },
    InvalidResultArity {
        result: u16,
    },
    InvalidGasCoinUsage,
    InvalidValueUsage,
    InvalidObjectByValue,
    InvalidObjectByMutRef,
    SharedObjectOperationNotAllowed,
    InvalidArgumentArity,
}

An error with an argument to a command

BCS

The BCS serialized form for this type is defined by the following ABNF:

command-argument-error =  type-mismatch
                       =/ invalid-bcs-bytes
                       =/ invalid-usage-of-pure-argument
                       =/ invalid-argument-to-private-entry-function
                       =/ index-out-of-bounds
                       =/ secondary-index-out-of-bound
                       =/ invalid-result-arity
                       =/ invalid-gas-coin-usage
                       =/ invalid-value-usage
                       =/ invalid-object-by-value
                       =/ invalid-object-by-mut-ref
                       =/ shared-object-operation-not-allowed

type-mismatch                               = %x00
invalid-bcs-bytes                           = %x01
invalid-usage-of-pure-argument              = %x02
invalid-argument-to-private-entry-function  = %x03
index-out-of-bounds                         = %x04 u16
secondary-index-out-of-bound                = %x05 u16 u16
invalid-result-arity                        = %x06 u16
invalid-gas-coin-usage                      = %x07
invalid-value-usage                         = %x08
invalid-object-by-value                     = %x09
invalid-object-by-mut-ref                   = %x0a
shared-object-operation-not-allowed         = %x0b

Variants

TypeMismatch

The type of the value does not match the expected type

InvalidBcsBytes

The argument cannot be deserialized into a value of the specified type

InvalidUsageOfPureArgument

The argument cannot be instantiated from raw bytes

InvalidArgumentToPrivateEntryFunction

Invalid argument to private entry function. Private entry functions cannot take arguments from other Move functions.

IndexOutOfBounds

Out of bounds access to input or results

Fields

index: u16

SecondaryIndexOutOfBounds

Out of bounds access to subresult

Fields

result: u16

subresult: u16

InvalidResultArity

Invalid usage of result. Expected a single result but found either no return value or multiple.

Fields

result: u16

InvalidGasCoinUsage

Invalid usage of Gas coin. The Gas coin can only be used by-value with a TransferObjects command.

InvalidValueUsage

Invalid usage of move value.

InvalidObjectByValue

Immutable objects cannot be passed by-value.

InvalidObjectByMutRef

Immutable objects cannot be passed by mutable reference, &mut.

SharedObjectOperationNotAllowed

Shared object operations such a wrapping, freezing, or converting to owned are not allowed.

InvalidArgumentArity

Invalid argument arity. Expected a single argument but found a result that expanded to multiple arguments.

Trait Implementations

impl Arbitrary for CommandArgumentError

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<CommandArgumentError>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(args: <Self as Arbitrary>::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for CommandArgumentError

fn clone(&self) -> CommandArgumentError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommandArgumentError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandArgumentError

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CommandArgumentError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CommandArgumentError

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CommandArgumentError

impl StructuralPartialEq for CommandArgumentError