Enum Command

#[non_exhaustive]
pub enum Command {
    MoveCall(MoveCall),
    TransferObjects(TransferObjects),
    SplitCoins(SplitCoins),
    MergeCoins(MergeCoins),
    Publish(Publish),
    MakeMoveVector(MakeMoveVector),
    Upgrade(Upgrade),
}

A single command in a programmable transaction.

BCS

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

command =  command-move-call
        =/ command-transfer-objects
        =/ command-split-coins
        =/ command-merge-coins
        =/ command-publish
        =/ command-make-move-vector
        =/ command-upgrade

command-move-call           = %x00 move-call
command-transfer-objects    = %x01 transfer-objects
command-split-coins         = %x02 split-coins
command-merge-coins         = %x03 merge-coins
command-publish             = %x04 publish
command-make-move-vector    = %x05 make-move-vector
command-upgrade             = %x06 upgrade

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

MoveCall(MoveCall)

A call to either an entry or a public Move function

TransferObjects(TransferObjects)

(Vec<forall T:key+store. T>, address) It sends n-objects to the specified address. These objects must have store (public transfer) and either the previous owner must be an address or the object must be newly created.

SplitCoins(SplitCoins)

(&mut Coin<T>, Vec<u64>) -> Vec<Coin<T>> It splits off some amounts into a new coins with those amounts

MergeCoins(MergeCoins)

(&mut Coin<T>, Vec<Coin<T>>) It merges n-coins into the first coin

Publish(Publish)

Publishes a Move package. It takes the package bytes and a list of the package’s transitive dependencies to link against on-chain.

MakeMoveVector(MakeMoveVector)

forall T: Vec<T> -> vector<T> Given n-values of the same type, it constructs a vector. For non objects or an empty vector, the type tag must be specified.

Upgrade(Upgrade)

Upgrades a Move package Takes (in order):

1. A vector of serialized modules for the package.
2. A vector of object ids for the transitive dependencies of the new package.
3. The object ID of the package being upgraded.
4. An argument holding the UpgradeTicket that must have been produced from an earlier command in the same programmable transaction.

Trait Implementations

impl Arbitrary for Command

type Parameters = ()

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

type Strategy = BoxedStrategy<Command>

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 Command

fn clone(&self) -> Command

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Command

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Command

fn eq(&self, other: &Command) -> 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 Command

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 Command

impl StructuralPartialEq for Command