Struct CreateCanisterBuilder 

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

A builder for a create_canister call.

Implementations

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

pub fn builder(canister: &'canister Canister<'agent>) -> 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 as_provisional_create_with_specified_id( self, specified_id: Principal, ) -> Self

Specify the canister id.

The effective_canister_id will also be set with the same value so that ic-ref can determine the target subnet of this request. The replica implementation ignores it.

pub fn with_effective_canister_id<C, E>(self, effective_canister_id: C) -> Self

where E: Display, C: TryInto<Principal, Error = E>,

Pass in an effective canister id for the update call.

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 with_reserved_cycles_limit<C, E>(self, limit: C) -> Self

where E: Display, C: TryInto<ReservedCyclesLimit, Error = E>,

Pass in a reserved cycles limit value for the canister.

pub fn with_optional_reserved_cycles_limit<E, C>(self, limit: Option<C>) -> Self

where E: Display, C: TryInto<ReservedCyclesLimit, Error = E>,

Pass in a reserved cycles limit optional value for the canister. If this is None, it will create the canister with the default limit.

pub fn with_wasm_memory_limit<C, E>(self, wasm_memory_limit: C) -> Self

where E: Display, C: TryInto<WasmMemoryLimit, Error = E>,

Pass in a Wasm memory limit value for the canister.

pub fn with_optional_wasm_memory_limit<E, C>( self, wasm_memory_limit: Option<C>, ) -> Self

where E: Display, C: TryInto<WasmMemoryLimit, Error = E>,

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

pub fn with_wasm_memory_threshold<C, E>(self, wasm_memory_threshold: C) -> Self

where E: Display, C: TryInto<WasmMemoryLimit, Error = E>,

Pass in a Wasm memory threshold value for the canister.

pub fn with_optional_wasm_memory_threshold<E, C>( self, wasm_memory_threshold: Option<C>, ) -> Self

where E: Display, C: TryInto<WasmMemoryLimit, Error = E>,

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

pub fn with_log_visibility<C, E>(self, log_visibility: C) -> Self

where E: Display, C: TryInto<LogVisibility, Error = E>,

Pass in a log visibility setting for the canister.

pub fn with_optional_log_visibility<E, C>( self, log_visibility: Option<C>, ) -> Self

where E: Display, C: TryInto<LogVisibility, Error = E>,

Pass in a log visibility optional setting for the canister. If this is None, it will revert the log visibility to default.

pub fn with_environment_variables<E, C>(self, environment_variables: C) -> Self

where E: Display, C: TryInto<Vec<EnvironmentVariable>, Error = E>,

Pass in a environment variables setting for the canister.

pub fn with_optional_environment_variables<E, C>( self, environment_variables: Option<C>, ) -> Self

where E: Display, C: TryInto<Vec<EnvironmentVariable>, Error = E>,

Pass in a environment variables optional setting for the canister. If this is None, it will revert the environment variables to default.

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

Create an AsyncCall implementation that, when called, will create a canister.

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

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

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

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

Trait Implementations

impl<'agent, 'canister: 'agent> AsyncCall for CreateCanisterBuilder<'agent, 'canister>

type Value = (Principal,)

The return type of the Candid function being called.

fn call<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = Result<CallResponse<(Principal,)>, AgentError>> + '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<(Principal,), AgentError>> + '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<'a, Out2, R, AndThen>( self, and_then: AndThen, ) -> AndThenAsyncCaller<'a, Self::Value, Out2, Self, R, AndThen>

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

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

fn map<'a, Out, Map>( self, map: Map, ) -> MappedAsyncCaller<'a, Self::Value, Out, Self, Map>

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

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

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

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

Formats the value using the given formatter.

impl<'agent, 'canister: 'agent> IntoFuture for CreateCanisterBuilder<'agent, 'canister>

type IntoFuture = Pin<Box<dyn Future<Output = Result<(Principal,), AgentError>> + 'agent>>

Which kind of future are we turning this into?

type Output = Result<(Principal,), AgentError>

The output that the future will produce on completion.

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.