CommandArgumentError
sealed class 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
Inheritors
Types
| Name | Summary |
|---|---|
| IndexOutOfBounds | data class IndexOutOfBounds(val index: UShort) : CommandArgumentError Out of bounds access to input or results |
| InvalidArgumentArity | object InvalidArgumentArity : CommandArgumentError Invalid argument arity. Expected a single argument but found a result that expanded to multiple arguments. |
| InvalidArgumentToPrivateEntryFunction | object InvalidArgumentToPrivateEntryFunction : CommandArgumentError Invalid argument to private entry function. Private entry functions cannot take arguments from other Move functions. |
| InvalidBcsBytes | object InvalidBcsBytes : CommandArgumentError The argument cannot be deserialized into a value of the specified type |
| InvalidGasCoinUsage | object InvalidGasCoinUsage : CommandArgumentError Invalid usage of Gas coin. The Gas coin can only be used by-value with a TransferObjects command. |
| InvalidObjectByMutRef | object InvalidObjectByMutRef : CommandArgumentError Immutable objects cannot be passed by mutable reference, &mut. |
| InvalidObjectByValue | object InvalidObjectByValue : CommandArgumentError Immutable objects cannot be passed by-value. |
| InvalidResultArity | data class InvalidResultArity(val result: UShort) : CommandArgumentError Invalid usage of result. Expected a single result but found either no return value or multiple. |
| InvalidUsageOfPureArgument | object InvalidUsageOfPureArgument : CommandArgumentError The argument cannot be instantiated from raw bytes |
| InvalidValueUsage | object InvalidValueUsage : CommandArgumentError Invalid usage of move value. |
| SecondaryIndexOutOfBounds | data class SecondaryIndexOutOfBounds(val result: UShort, val subresult: UShort) : CommandArgumentError Out of bounds access to subresult |
| SharedObjectOperationNotAllowed | object SharedObjectOperationNotAllowed : CommandArgumentError Shared object operations such a wrapping, freezing, or converting to owned are not allowed. |
| TypeMismatch | object TypeMismatch : CommandArgumentError The type of the value does not match the expected type |
IndexOutOfBounds
data class IndexOutOfBounds(val index: UShort) : CommandArgumentError
Out of bounds access to input or results
Constructors
| IndexOutOfBounds | constructor(index: UShort) |
Properties
| Name | Summary |
|---|---|
| index | val index: UShort |
InvalidArgumentArity
object InvalidArgumentArity : CommandArgumentError
Invalid argument arity. Expected a single argument but found a result that expanded to multiple arguments.
InvalidArgumentToPrivateEntryFunction
object InvalidArgumentToPrivateEntryFunction : CommandArgumentError
Invalid argument to private entry function. Private entry functions cannot take arguments from other Move functions.
InvalidBcsBytes
object InvalidBcsBytes : CommandArgumentError
The argument cannot be deserialized into a value of the specified type
InvalidGasCoinUsage
object InvalidGasCoinUsage : CommandArgumentError
Invalid usage of Gas coin. The Gas coin can only be used by-value with a TransferObjects command.
InvalidObjectByMutRef
object InvalidObjectByMutRef : CommandArgumentError
Immutable objects cannot be passed by mutable reference, &mut.
InvalidObjectByValue
object InvalidObjectByValue : CommandArgumentError
Immutable objects cannot be passed by-value.
InvalidResultArity
data class InvalidResultArity(val result: UShort) : CommandArgumentError
Invalid usage of result. Expected a single result but found either no return value or multiple.
Constructors
| InvalidResultArity | constructor(result: UShort) |
Properties
| Name | Summary |
|---|---|
| result | val result: UShort |
InvalidUsageOfPureArgument
object InvalidUsageOfPureArgument : CommandArgumentError
The argument cannot be instantiated from raw bytes
InvalidValueUsage
object InvalidValueUsage : CommandArgumentError
Invalid usage of move value.
SecondaryIndexOutOfBounds
data class SecondaryIndexOutOfBounds(val result: UShort, val subresult: UShort) : CommandArgumentError
Out of bounds access to subresult
Constructors
| SecondaryIndexOutOfBounds | constructor(result: UShort, subresult: UShort) |
Properties
| Name | Summary |
|---|---|
| result | val result: UShort |
| subresult | val subresult: UShort |
SharedObjectOperationNotAllowed
object SharedObjectOperationNotAllowed : CommandArgumentError
Shared object operations such a wrapping, freezing, or converting to owned are not allowed.
TypeMismatch
object TypeMismatch : CommandArgumentError
The type of the value does not match the expected type