Enum Argument 

#[non_exhaustive]
pub enum Argument {
    Gas,
    Input(u16),
    Result(u16),
    NestedResult(u16, u16),
}

An argument to a programmable transaction command

BCS

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

argument    =  argument-gas
            =/ argument-input
            =/ argument-result
            =/ argument-nested-result

argument-gas            = %d00
argument-input          = %d01 u16
argument-result         = %d02 u16
argument-nested-result  = %d03 u16 u16

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.

Gas

The gas coin. The gas coin can only be used by-ref, except for with TransferObjects, which can use it by-value.

Input(u16)

One of the input objects or primitive values (from ProgrammableTransaction inputs)

Result(u16)

The result of another command (from ProgrammableTransaction commands)

NestedResult(u16, u16)

Like a Result but it accesses a nested result. Currently, the only usage of this is to access a value from a Move call with multiple return values.

Implementations

impl Argument

pub fn is_gas(&self) -> bool

Checks if this is a gas variant.

pub fn is_input(&self) -> bool

Checks if this is a input variant.

pub fn is_result(&self) -> bool

Checks if this is a result variant.

pub fn is_nested_result(&self) -> bool

Checks if this is a nested_result variant.

pub fn as_input_opt(&self) -> Option<u16>

pub fn as_input(&self) -> u16

pub fn as_result_opt(&self) -> Option<u16>

pub fn as_result(&self) -> u16

pub fn as_nested_result_opt(&self) -> Option<(u16, u16)>

pub fn as_nested_result(&self) -> (u16, u16)

pub fn get_nested_result(&self, ix: u16) -> Option<Argument>

Get the nested result for this result at the given index. Returns None if this is not a Result.

Trait Implementations

impl Arbitrary for Argument

type Parameters = ()

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

type Strategy = BoxedStrategy<Argument>

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

fn arbitrary_with( args_shared: <Argument as Arbitrary>::Parameters, ) -> <Argument as Arbitrary>::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 Argument

fn clone(&self) -> Argument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Argument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Argument

fn deserialize<D>( deserializer: D, ) -> Result<Argument, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Argument

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

Formats the value using the given formatter.

impl Hash for Argument

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Argument

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Argument

impl Eq for Argument

impl StructuralPartialEq for Argument