Enum Command 

pub enum Command<N: Network> {
    Instruction(Instruction<N>),
    Await(Await<N>),
    Contains(Contains<N>),
    ContainsDynamic(ContainsDynamic<N>),
    Get(Get<N>),
    GetDynamic(GetDynamic<N>),
    GetOrUse(GetOrUse<N>),
    GetOrUseDynamic(GetOrUseDynamic<N>),
    RandChaCha(RandChaCha<N>),
    Remove(Remove<N>),
    Set(Set<N>),
    BranchEq(BranchEq<N>),
    BranchNeq(BranchNeq<N>),
    Position(Position<N>),
}

Variants

Instruction(Instruction<N>)

Evaluates the instruction.

Await(Await<N>)

Awaits the result of a future.

Contains(Contains<N>)

Returns true if the key operand is present in mapping, and stores the result into destination.

ContainsDynamic(ContainsDynamic<N>)

Resolves the program and mapping operands, returns true if the key operand is present in the mapping, and stores the result into destination.

Get(Get<N>)

Gets the value stored at the key operand in mapping and stores the result into destination.

GetDynamic(GetDynamic<N>)

Resolves the program and mapping operands, gets the value stored at the key operand in mapping, and stores the result into destination.

GetOrUse(GetOrUse<N>)

Gets the value stored at the key operand in mapping and stores the result into destination. If the key is not present, default is stored into destination.

GetOrUseDynamic(GetOrUseDynamic<N>)

Resolves the program and mapping operands, gets the value stored at the key operand in mapping, and stores the result into destination. If the key is not present, default is stored into destination.

RandChaCha(RandChaCha<N>)

Generates a random value using the rand.chacha command and stores the result into destination.

Remove(Remove<N>)

Removes the (key, value) entry from the mapping.

Set(Set<N>)

Sets the value stored at the key operand in the mapping to value.

BranchEq(BranchEq<N>)

Jumps to the position, if first equals second.

BranchNeq(BranchNeq<N>)

Jumps to the position, if first does not equal second.

Position(Position<N>)

Indicates a position to which the program can branch to.

Implementations

impl<N: Network> Command<N>

pub fn is_async(&self) -> bool

Returns true if the command is an async instruction.

pub fn is_await(&self) -> bool

Returns true if the command is an await command.

pub fn is_call(&self) -> bool

Returns true if the command is a call instruction.

pub fn is_cast_to_record(&self) -> bool

Returns true if the command is a cast to record instruction.

pub fn is_write(&self) -> bool

Returns true if the command is a write operation.

pub fn branch_to(&self) -> Option<&Identifier<N>>

Returns the branch target, if the command is a branch command. Otherwise, returns None.

pub fn position(&self) -> Option<&Identifier<N>>

Returns the position name, if the command is a position command. Otherwise, returns None.

pub fn destinations(&self) -> Vec<Register<N>>

Returns the destination registers of the command.

pub fn operands(&self) -> &[Operand<N>]

Returns the operands of the command.

pub fn finalize( &self, stack: &impl StackTrait<N>, store: &impl FinalizeStoreTrait<N>, registers: &mut impl FinalizeRegistersState<N>, ) -> Result<Option<FinalizeOperation<N>>>

Finalizes the command.

pub fn contains_external_struct(&self) -> bool

Returns whether this commands refers to an external struct.

pub fn contains_string_type(&self) -> bool

Returns true if the command contains a string type.

pub fn contains_identifier_type(&self) -> Result<bool>

Returns true if the command contains an identifier type in its cast type.

pub fn exceeds_max_array_size(&self, max_array_size: u32) -> bool

Returns true if the command contains an array type with a size that exceeds the given maximum.

Trait Implementations

impl<N: Clone + Network> Clone for Command<N>

fn clone(&self) -> Command<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N: Network> Debug for Command<N>

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

Prints the command as a string.

impl<N: Network> Display for Command<N>

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

Prints the command as a string.

impl<N: Network> FromBytes for Command<N>

fn read_le<R: Read>(reader: R) -> IoResult<Self>

Reads the command from a buffer.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Returns Self from a byte array in little-endian order.

fn from_bytes_le_unchecked(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Same behavior as Self::from_bytes_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_unchecked<R>(reader: R) -> Result<Self, Error>

where R: Read, Self: Sized,

Same behavior as Self::read_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_with_unchecked<R>(reader: R, unchecked: bool) -> Result<Self, Error>

where R: Read, Self: Sized,

Helper function that deserializes either unchecked or checked based on the given boolean flag.

impl<N: Network> FromStr for Command<N>

fn from_str(string: &str) -> Result<Self>

Parses the string into the command.

type Err = Error

The associated error which can be returned from parsing.

impl<N: Hash + Network> Hash for Command<N>

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

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<N: Network> Parser for Command<N>

fn parse(string: &str) -> ParserResult<'_, Self>

Parses the string into the command.

impl<N: PartialEq + Network> PartialEq for Command<N>

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

fn write_le<W: Write>(&self, writer: W) -> IoResult<()>

Writes the command to a buffer.

fn to_bytes_le(&self) -> Result<Vec<u8>, Error>

where Self: Sized,

Returns self as a byte array in little-endian order.

impl<N: Eq + Network> Eq for Command<N>

impl<N: Network> StructuralPartialEq for Command<N>