Struct ic_utils::interfaces::management_canister::builders::InstallCodeBuilder

pub struct InstallCodeBuilder<'agent, 'canister: 'agent> { /* private fields */ }

A builder for an install_code call.

Implementations

impl<'agent, 'canister: 'agent> InstallCodeBuilder<'agent, 'canister>

pub fn builder( canister: &'canister Canister<'agent>, canister_id: &Principal, wasm: &'canister [u8] ) -> Self

Create an InstallCode builder, which is also an AsyncCall implementation.

pub fn with_arg<Argument: CandidType>( self, arg: Argument ) -> InstallCodeBuilder<'agent, 'canister>

Set the argument to the installation, which will be passed to the init method of the canister. Can be called at most once.

pub fn with_args(self, tuple: impl ArgumentEncoder) -> Self

Set the argument with multiple arguments as tuple to the installation, which will be passed to the init method of the canister. Can be called at most once.

pub fn with_raw_arg(self, arg: Vec<u8>) -> InstallCodeBuilder<'agent, 'canister>

Set the argument passed in to the canister with raw bytes. Can be called at most once.

pub fn with_mode(self, mode: InstallMode) -> Self

Pass in the InstallMode.

pub fn build(self) -> Result<impl 'agent + AsyncCall<()>, AgentError>

Create an AsyncCall implementation that, when called, will install the canister.

pub async fn call(self) -> Result<RequestId, AgentError>

Make a call. This is equivalent to the AsyncCall::call.

pub async fn call_and_wait(self) -> Result<(), AgentError>

Make a call. This is equivalent to the AsyncCall::call_and_wait.

Trait Implementations

impl<'agent, 'canister: 'agent> AsyncCall<()> for InstallCodeBuilder<'agent, 'canister>

fn call<'async_trait>( self ) -> Pin<Box<dyn Future<Output = Result<RequestId, AgentError>> + Send + 'async_trait>>

where Self: 'async_trait,

Execute the call, but returns the RequestId. Waiting on the request Id must be managed by the caller using the Agent directly.

fn call_and_wait<'async_trait>( self ) -> Pin<Box<dyn Future<Output = Result<(), AgentError>> + Send + 'async_trait>>

where Self: 'async_trait,

Execute the call, and wait for an answer using an exponential-backoff strategy. The return type is encoded in the trait.

fn and_then<Out2, R, AndThen>( self, and_then: AndThen ) -> AndThenAsyncCaller<Out, Out2, Self, R, AndThen>

where Self: Sized + Send, Out2: for<'de> ArgumentDecoder<'de> + Send, R: Future<Output = Result<Out2, AgentError>> + Send, AndThen: Send + Fn(Out) -> R,

Apply a transformation function after the call has been successful. The transformation is applied with the result.

fn map<Out2, Map>(self, map: Map) -> MappedAsyncCaller<Out, Out2, Self, Map>

where Self: Sized + Send, Out2: for<'de> ArgumentDecoder<'de> + Send, Map: Send + Fn(Out) -> Out2,

Apply a transformation function after the call has been successful. Equivalent to .and_then(|x| async { map(x) }).

impl<'agent, 'canister: 'agent> Debug for InstallCodeBuilder<'agent, 'canister>

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

Formats the value using the given formatter.