Struct ic_utils::interfaces::management_canister::builders::InstallChunkedCodeBuilder

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

A builder for an install_chunked_code call.

Implementations

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

pub fn builder( canister: &'canister Canister<'agent>, target_canister: Principal, wasm_module_hash: ChunkHash ) -> Self

Create an InstallChunkedCodeBuilder.

pub fn with_chunk_hashes(self, chunk_hashes: Vec<ChunkHash>) -> Self

Set the chunks to install. These must previously have been set with ManagementCanister::upload_chunk.

pub fn with_storage_canister(self, storage_canister: Principal) -> Self

Set the canister to pull uploaded chunks from. By default this is the same as the target canister.

pub fn with_arg(self, argument: impl CandidType) -> Self

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, argument: 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, argument: Vec<u8>) -> Self

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

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

Set 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 the call. This is equivalent to AsyncCall::call.

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

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

Trait Implementations

impl<'agent, 'canister: 'agent> AsyncCall<()> for InstallChunkedCodeBuilder<'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> Debug for InstallChunkedCodeBuilder<'agent, 'canister>

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

Formats the value using the given formatter.