Struct ic_utils::interfaces::management_canister::builders::CreateCanisterBuilder

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

A builder for a create_canister call.

Implementations

impl<'agent, 'canister: 'agent, T> CreateCanisterBuilder<'agent, 'canister, T>

pub fn builder(canister: &'canister Canister<'agent, T>) -> Self

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

pub fn as_provisional_create_with_amount(self, amount: Option<u128>) -> Self

Until developers can convert real ICP tokens to provision a new canister with cycles, the system provides the provisional_create_canister_with_cycles method. It behaves as create_canister, but initializes the canister’s balance with amount fresh cycles (using MAX_CANISTER_BALANCE if amount = null, else capping the balance at MAX_CANISTER_BALANCE). Cycles added to this call via ic0.call_cycles_add are returned to the caller. This method is only available in local development instances, and will be removed in the future.

pub fn with_optional_controller<C, E>(self, controller: Option<C>) -> Self where
    E: Display,
    C: TryInto<Principal, Error = E>, 

Pass in an optional controller for the canister. If this is None, it will revert the controller to default.

pub fn with_controller<C, E>(self, controller: C) -> Self where
    E: Display,
    C: TryInto<Principal, Error = E>, 

Pass in a designated controller for the canister.

pub fn with_optional_compute_allocation<C, E>(
    self,
    compute_allocation: Option<C>
) -> Self where
    E: Display,
    C: TryInto<ComputeAllocation, Error = E>, 

Pass in a compute allocation optional value for the canister. If this is None, it will revert the compute allocation to default.

pub fn with_compute_allocation<C, E>(self, compute_allocation: C) -> Self where
    E: Display,
    C: TryInto<ComputeAllocation, Error = E>, 

Pass in a compute allocation value for the canister.

pub fn with_optional_memory_allocation<E, C>(
    self,
    memory_allocation: Option<C>
) -> Self where
    E: Display,
    C: TryInto<MemoryAllocation, Error = E>, 

Pass in a memory allocation optional value for the canister. If this is None, it will revert the memory allocation to default.

pub fn with_memory_allocation<C, E>(self, memory_allocation: C) -> Self where
    E: Display,
    C: TryInto<MemoryAllocation, Error = E>, 

Pass in a memory allocation value for the canister.

pub fn with_optional_freezing_threshold<E, C>(
    self,
    freezing_threshold: Option<C>
) -> Self where
    E: Display,
    C: TryInto<FreezingThreshold, Error = E>, 

Pass in a freezing threshold optional value for the canister. If this is None, it will revert the freezing threshold to default.

pub fn with_freezing_threshold<C, E>(self, freezing_threshold: C) -> Self where
    E: Display,
    C: TryInto<FreezingThreshold, Error = E>, 

Pass in a freezing threshold value for the canister.

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

Create an AsyncCall implementation that, when called, will create a 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<W>(
    self,
    waiter: W
) -> Result<(Principal,), AgentError> where
    W: Waiter, 

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

Trait Implementations

impl<'agent, 'canister: 'agent, T: Sync> AsyncCall<(Principal,)> for CreateCanisterBuilder<'agent, 'canister, T>

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, W>(
    self,
    waiter: W
) -> Pin<Box<dyn Future<Output = Result<(Principal,), AgentError>> + Send + 'async_trait>> where
    W: Waiter,
    W: 'async_trait,
    Self: 'async_trait, 

Execute the call, and wait for an answer using a Waiter 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, T: Debug> Debug for CreateCanisterBuilder<'agent, 'canister, T>

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

Formats the value using the given formatter.