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

Represents a collection of arguments passed to a smart contract.

Implementations§

source§

impl RuntimeArgs

source

pub fn new() -> RuntimeArgs

Create an empty RuntimeArgs instance.

source

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.

source

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

Gets an argument by its name.

source

pub fn len(&self) -> usize

Gets the length of the collection.

source

pub fn is_empty(&self) -> bool

Returns true if the collection of arguments is empty.

source

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.

source

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.

source

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

Returns all the values of the named args.

source

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

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

source

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

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

source

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§

source§

impl Clone for RuntimeArgs

source§

fn clone(&self) -> RuntimeArgs

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for RuntimeArgs

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for RuntimeArgs

source§

fn default() -> RuntimeArgs

Returns the “default value” for a type. Read more
source§

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

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

impl From<Vec<NamedArg>> for RuntimeArgs

source§

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

Converts to this type from the input type.
source§

impl FromBytes for RuntimeArgs

source§

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

Deserializes the slice into Self.
source§

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

Deserializes the Vec<u8> into Self.
source§

impl Hash for RuntimeArgs

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for RuntimeArgs

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for RuntimeArgs

source§

fn eq(&self, other: &RuntimeArgs) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for RuntimeArgs

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Serialize for RuntimeArgs

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl ToBytes for RuntimeArgs

source§

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

Serializes &self to a Vec<u8>.
source§

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.
source§

fn into_bytes(self) -> Result<Vec<u8>, Error>where Self: Sized,

Consumes self and serializes to a Vec<u8>.
source§

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

Writes &self into a mutable writer.
source§

impl Eq for RuntimeArgs

source§

impl StructuralEq for RuntimeArgs

source§

impl StructuralPartialEq for RuntimeArgs

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,