Struct casper_types::RuntimeArgs

pub struct RuntimeArgs(/* private fields */);

Represents a collection of arguments passed to a smart contract.

Implementations

impl RuntimeArgs

pub fn new() -> RuntimeArgs

Create an empty RuntimeArgs instance.

pub fn try_new<F>(func: F) -> Result<RuntimeArgs, CLValueError>

where F: FnOnce(&mut RuntimeArgs) -> Result<(), CLValueError>,

A wrapper that lets you easily and safely create runtime arguments.

This method is useful when you have to construct a RuntimeArgs with multiple entries, but error handling at given call site would require to have a match statement for each RuntimeArgs::insert call. With this method you can use ? operator inside the closure and then handle single result. When try_block will be stabilized this method could be deprecated in favor of using those blocks.

pub fn get(&self, name: &str) -> Option<&CLValue>

Gets an argument by its name.

pub fn len(&self) -> usize

Gets the length of the collection.

pub fn is_empty(&self) -> bool

Returns true if the collection of arguments is empty.

pub fn insert<K, V>(&mut self, key: K, value: V) -> Result<(), CLValueError>

where K: Into<String>, V: CLTyped + ToBytes,

Inserts a new named argument into the collection.

pub fn insert_cl_value<K>(&mut self, key: K, cl_value: CLValue)

where K: Into<String>,

Inserts a new named argument into the collection.

pub fn to_values(&self) -> Vec<&CLValue>

Returns all the values of the named args.

pub fn named_args(&self) -> impl Iterator<Item = &NamedArg>

Returns an iterator of references over all arguments in insertion order.

pub fn named_args_mut(&mut self) -> impl Iterator<Item = &mut NamedArg>

Returns an iterator of mutable references over all arguments in insertion order.

pub fn try_get_number(&self, name: &str) -> Result<U512, CLValueError>

Returns the numeric value of name arg from the runtime arguments or defaults to 0 if that arg doesn’t exist or is not an integer type.

Supported CLTypes for numeric conversions are U64, and U512.

Returns an error if parsing the arg fails.

Trait Implementations

impl Clone for RuntimeArgs

fn clone(&self) -> RuntimeArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RuntimeArgs

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

Formats the value using the given formatter.

impl Default for RuntimeArgs

fn default() -> RuntimeArgs

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RuntimeArgs

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<BTreeMap<String, CLValue>> for RuntimeArgs

fn from(cl_values: BTreeMap<String, CLValue>) -> RuntimeArgs

Converts to this type from the input type.

impl From<RuntimeArgs> for BTreeMap<String, CLValue>

fn from(args: RuntimeArgs) -> BTreeMap<String, CLValue>

Converts to this type from the input type.

impl From<Vec<NamedArg>> for RuntimeArgs

fn from(values: Vec<NamedArg>) -> Self

Converts to this type from the input type.

impl FromBytes for RuntimeArgs

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

Deserializes the slice into Self.

fn from_vec(bytes: Vec<u8>) -> Result<(Self, Vec<u8>), Error>

Deserializes the Vec<u8> into Self.

impl Hash for RuntimeArgs

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 Ord for RuntimeArgs

fn cmp(&self, other: &RuntimeArgs) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for RuntimeArgs

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

fn partial_cmp(&self, other: &RuntimeArgs) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for RuntimeArgs

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToBytes for RuntimeArgs

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

Serializes &self to a Vec<u8>.

fn serialized_length(&self) -> usize

Returns the length of the Vec<u8> which would be returned from a successful call to to_bytes() or into_bytes(). The data is not actually serialized, so this call is relatively cheap.

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

where Self: Sized,

Consumes self and serializes to a Vec<u8>.

fn write_bytes(&self, writer: &mut Vec<u8>) -> Result<(), Error>

Writes &self into a mutable writer.

impl Eq for RuntimeArgs

impl StructuralPartialEq for RuntimeArgs