Struct UpdateCanisterBuilder 

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

A builder for an update_settings call.

Implementations

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

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

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

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, leaves the reserved cycles limit unchanged.

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, leaves the Wasm memory limit unchanged.

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 value for the canister. If this is None, leaves the memory threshold unchanged.

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, leaves the log visibility unchanged.

pub fn with_environment_variables<C, E>(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, leaves the environment variables unchanged.

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

Create an AsyncCall implementation that, when called, will update a canisters settings.

pub async fn call(self) -> Result<CallResponse<()>, 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 UpdateCanisterBuilder<'agent, 'canister>

type Value = ()

The return type of the Candid function being called.

fn call<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = Result<CallResponse<()>, 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<(), 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 UpdateCanisterBuilder<'agent, 'canister>

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

Formats the value using the given formatter.

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

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

Which kind of future are we turning this into?

type Output = Result<(), AgentError>

The output that the future will produce on completion.

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.