Skip to main content

CommandArgumentError

CommandArgumentError​

enum CommandArgumentError

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                               = %d00
invalid-bcs-bytes                           = %d01
invalid-usage-of-pure-argument              = %d02
invalid-argument-to-private-entry-function  = %d03
index-out-of-bounds                         = %d04 u16
secondary-index-out-of-bound                = %d05 u16 u16
invalid-result-arity                        = %d06 u16
invalid-gas-coin-usage                      = %d07
invalid-value-usage                         = %d08
invalid-object-by-value                     = %d09
invalid-object-by-mut-ref                   = %d10
shared-object-operation-not-allowed         = %d11

CommandArgumentError.indexOutOfBounds(index:)​

case indexOutOfBounds(index: UInt16)

Out of bounds access to input or results

CommandArgumentError.invalidArgumentArity​

case invalidArgumentArity

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

CommandArgumentError.invalidArgumentToPrivateEntryFunction​

case invalidArgumentToPrivateEntryFunction

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

CommandArgumentError.invalidBcsBytes​

case invalidBcsBytes

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

CommandArgumentError.invalidGasCoinUsage​

case invalidGasCoinUsage

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

CommandArgumentError.invalidObjectByMutRef​

case invalidObjectByMutRef

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

CommandArgumentError.invalidObjectByValue​

case invalidObjectByValue

Immutable objects cannot be passed by-value.

CommandArgumentError.invalidResultArity(result:)​

case invalidResultArity(result: UInt16)

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

CommandArgumentError.invalidUsageOfPureArgument​

case invalidUsageOfPureArgument

The argument cannot be instantiated from raw bytes

CommandArgumentError.invalidValueUsage​

case invalidValueUsage

Invalid usage of move value.

CommandArgumentError.secondaryIndexOutOfBounds(result:subresult:)​

case secondaryIndexOutOfBounds(result: UInt16, subresult: UInt16)

Out of bounds access to subresult

CommandArgumentError.sharedObjectOperationNotAllowed​

case sharedObjectOperationNotAllowed

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

CommandArgumentError.typeMismatch​

case typeMismatch

The type of the value does not match the expected type

!=(_:_:)​

static func != (lhs: Self, rhs: Self) -> Bool

Returns a Boolean value indicating whether two values are not equal.

Inequality is the inverse of equality. For any values a and b, a != b implies that a == b is false.

This is the default implementation of the not-equal-to operator (!=) for any type that conforms to Equatable.

  • Parameters:
    • lhs: A value to compare.
    • rhs: Another value to compare.