Struct Argument

#[non_exhaustive]
pub struct Argument {
    pub kind: Option<i32>,
    pub input: Option<u32>,
    pub result: Option<u32>,
    pub subresult: Option<u32>,
}

An argument to a programmable transaction command.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

kind: Option<i32>

input: Option<u32>

Index of an input when kind is INPUT.

result: Option<u32>

Index of a result when kind is RESULT.

subresult: Option<u32>

Used to access a nested result when kind is RESULT.

Implementations

impl Argument

pub const KIND_FIELD: &'static MessageField

pub const INPUT_FIELD: &'static MessageField

pub const RESULT_FIELD: &'static MessageField

pub const SUBRESULT_FIELD: &'static MessageField

impl Argument

pub fn path_builder() -> ArgumentFieldPathBuilder

impl Argument

pub const fn const_default() -> Self

pub fn with_kind<T: Into<ArgumentKind>>(self, field: T) -> Self

Sets kind with the provided value.

pub fn input_opt_mut(&mut self) -> Option<&mut u32>

If input is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn input_mut(&mut self) -> &mut u32

Returns a mutable reference to input. If the field is unset, it is first initialized with the default value.

pub fn input_opt(&self) -> Option<u32>

If input is set, returns Some with the value; otherwise returns None.

pub fn set_input<T: Into<u32>>(&mut self, field: T)

Sets input with the provided value.

pub fn with_input<T: Into<u32>>(self, field: T) -> Self

Sets input with the provided value.

pub fn result_opt_mut(&mut self) -> Option<&mut u32>

If result is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn result_mut(&mut self) -> &mut u32

Returns a mutable reference to result. If the field is unset, it is first initialized with the default value.

pub fn result_opt(&self) -> Option<u32>

If result is set, returns Some with the value; otherwise returns None.

pub fn set_result<T: Into<u32>>(&mut self, field: T)

Sets result with the provided value.

pub fn with_result<T: Into<u32>>(self, field: T) -> Self

Sets result with the provided value.

pub fn subresult_opt_mut(&mut self) -> Option<&mut u32>

If subresult is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn subresult_mut(&mut self) -> &mut u32

Returns a mutable reference to subresult. If the field is unset, it is first initialized with the default value.

pub fn subresult_opt(&self) -> Option<u32>

If subresult is set, returns Some with the value; otherwise returns None.

pub fn set_subresult<T: Into<u32>>(&mut self, field: T)

Sets subresult with the provided value.

pub fn with_subresult<T: Into<u32>>(self, field: T) -> Self

Sets subresult with the provided value.

impl Argument

pub fn gas() -> Self

pub fn new_input(input: u16) -> Self

pub fn new_result(command: u16) -> Self

pub fn nested_result(command: u16, subresult: u16) -> Self

impl Argument

pub fn kind(&self) -> ArgumentKind

Returns the enum value of kind, or the default if the field is unset or set to an invalid enum value.

pub fn set_kind(&mut self, value: ArgumentKind)

Sets kind to the provided enum value.

pub fn input(&self) -> u32

Returns the value of input, or the default value if input is unset.

pub fn result(&self) -> u32

Returns the value of result, or the default value if result is unset.

pub fn subresult(&self) -> u32

Returns the value of subresult, or the default value if subresult is unset.

Trait Implementations

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

Formats the value using the given formatter.

impl Default for Argument

fn default() -> Self

Returns the “default value” for a type.

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

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Argument> for Argument

fn from(value: Argument) -> Self

Converts to this type from the input type.

impl Message for Argument

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl MessageFields for Argument

const FIELDS: &'static [&'static MessageField]

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::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Argument> for Argument

type Error = TryFromProtoError

The type returned in the event of a conversion error.

fn try_from(value: &Argument) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Argument

impl StructuralPartialEq for Argument