pub struct CreateCanisterBuilder<'agent, 'canister: 'agent> { /* private fields */ }
Expand description
A builder for a create_canister
call.
Implementations
sourceimpl<'agent, 'canister: 'agent> CreateCanisterBuilder<'agent, 'canister>
impl<'agent, 'canister: 'agent> CreateCanisterBuilder<'agent, 'canister>
sourcepub fn builder(canister: &'canister Canister<'agent>) -> Self
pub fn builder(canister: &'canister Canister<'agent>) -> Self
Create an CreateCanister builder, which is also an AsyncCall implementation.
sourcepub fn as_provisional_create_with_amount(self, amount: Option<u128>) -> Self
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.
sourcepub fn with_optional_controller<C, E>(self, controller: Option<C>) -> Self where
E: Display,
C: TryInto<Principal, Error = E>,
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.
sourcepub fn with_controller<C, E>(self, controller: C) -> Self where
E: Display,
C: TryInto<Principal, Error = E>,
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.
sourcepub fn with_optional_compute_allocation<C, E>(
self,
compute_allocation: Option<C>
) -> Self where
E: Display,
C: TryInto<ComputeAllocation, Error = E>,
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.
sourcepub fn with_compute_allocation<C, E>(self, compute_allocation: C) -> Self where
E: Display,
C: TryInto<ComputeAllocation, Error = E>,
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.
sourcepub fn with_optional_memory_allocation<E, C>(
self,
memory_allocation: Option<C>
) -> Self where
E: Display,
C: TryInto<MemoryAllocation, Error = E>,
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.
sourcepub fn with_memory_allocation<C, E>(self, memory_allocation: C) -> Self where
E: Display,
C: TryInto<MemoryAllocation, Error = E>,
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.
sourcepub fn with_optional_freezing_threshold<E, C>(
self,
freezing_threshold: Option<C>
) -> Self where
E: Display,
C: TryInto<FreezingThreshold, Error = E>,
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.
sourcepub fn with_freezing_threshold<C, E>(self, freezing_threshold: C) -> Self where
E: Display,
C: TryInto<FreezingThreshold, Error = E>,
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.
sourcepub fn build(self) -> Result<impl 'agent + AsyncCall<(Principal,)>, AgentError>
pub fn build(self) -> Result<impl 'agent + AsyncCall<(Principal,)>, AgentError>
Create an AsyncCall implementation that, when called, will create a canister.
sourcepub async fn call(self) -> Result<RequestId, AgentError>
pub async fn call(self) -> Result<RequestId, AgentError>
Make a call. This is equivalent to the AsyncCall::call.
sourcepub async fn call_and_wait<W>(
self,
waiter: W
) -> Result<(Principal,), AgentError> where
W: Waiter,
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
sourceimpl<'agent, 'canister: 'agent> AsyncCall<(Principal,)> for CreateCanisterBuilder<'agent, 'canister>
impl<'agent, 'canister: 'agent> AsyncCall<(Principal,)> for CreateCanisterBuilder<'agent, 'canister>
sourcefn call<'async_trait>(
self
) -> Pin<Box<dyn Future<Output = Result<RequestId, AgentError>> + Send + 'async_trait>> where
Self: 'async_trait,
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. Read more
sourcefn 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,
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,
sourcefn 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,
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. Read more
sourcefn 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,
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) })
.
Auto Trait Implementations
impl<'agent, 'canister> !RefUnwindSafe for CreateCanisterBuilder<'agent, 'canister>
impl<'agent, 'canister> Send for CreateCanisterBuilder<'agent, 'canister>
impl<'agent, 'canister> Sync for CreateCanisterBuilder<'agent, 'canister>
impl<'agent, 'canister> Unpin for CreateCanisterBuilder<'agent, 'canister> where
'agent: 'canister,
impl<'agent, 'canister> !UnwindSafe for CreateCanisterBuilder<'agent, 'canister>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more