Struct ic_utils::canister::Argument

pub struct Argument(_);

A builder for a canister argument, allowing you to append elements to an argument tuple with chaining syntax.

Implementations

impl Argument

pub fn push_idl_arg<A: CandidType>(&mut self, arg: A)

Add an IDL Argument. If the current value of Argument is Raw, will set the result to an error. If the current value is an error, will do nothing.

pub fn push_value_arg(&mut self, arg: IDLValue)

Add an IDLValue Argument. If the current value of Argument is Raw, will set the result to an error. If the current value is an error, will do nothing.

pub fn set_raw_arg(&mut self, arg: Vec<u8>)

Set the argument as raw, replacing any value that was there before. If the current argument was an error, does nothing.

pub fn serialize(self) -> Result<Vec<u8>, AgentError>

Encodes the completed argument into an IDL blob.

pub fn reset(&mut self)

Resets the argument to an empty builder.

pub fn new() -> Self

Creates an empty argument.

pub fn from_raw(raw: Vec<u8>) -> Self

Creates an argument from an arbitrary blob. Equivalent to [set_raw_arg].

pub fn from_candid(tuple: impl ArgumentEncoder) -> Self

Creates an argument from an existing Candid ArgumentEncoder.

Trait Implementations

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.