Struct DeployBuilder 

pub struct DeployBuilder<Canister, C: Caller> {
    pub provider: C::Provider,
    pub caller: C,
    pub canister_id: Option<Principal>,
    pub mode: DeployMode,
    pub settings: CanisterSettings,
    pub cycles: u128,
    pub wasm: Vec<u8>,
    pub args: Result<Vec<u8>, Error>,
    pub new: fn(&C, Principal) -> Canister,
}

Builder struct for configuring and performing a canister deployment.

Provides an ergonomic way to:

• Set the deployment mode (create, install, upgrade, reinstall)
• Attach initial cycles
• Define WASM module and settings
• Inject candid arguments
• Produce a typed client interface

Fields

provider: C::Provider

Provider that performs actual deployment (e.g. PocketIc).

caller: C

The logical caller for interactions post-deployment.

canister_id: Option<Principal>

Optional canister ID for pre-existing canisters.

mode: DeployMode

Deployment mode (create, install, etc.).

settings: CanisterSettings

Canister configuration (controllers, memory allocation, compute allocation, etc.).

cycles: u128

Initial cycles to add.

wasm: Vec<u8>

WASM module to install.

args: Result<Vec<u8>, Error>

Candid-encoded constructor arguments.

new: fn(&C, Principal) -> Canister

Function to wrap a raw Principal in a user-defined canister type.

Implementations

impl<Canister, C: Caller> DeployBuilder<Canister, C>

pub fn with_canister_id(self, canister_id: Principal) -> Self

pub fn with_controllers(self, controllers: Vec<Principal>) -> Self

pub fn with_cycles(self, cycles: u128) -> Self

pub fn with_settings(self, settings: CanisterSettings) -> Self

pub fn with_wasm(self, wasm: Vec<u8>) -> Self

pub fn with_install(self) -> Self

pub fn with_upgrade(self) -> Self

pub fn with_reinstall(self) -> Self

pub async fn maybe_call(self) -> Result<Canister, DeployError>

Execute the deployment, returning either a constructed canister interface or an error.

pub async fn call(self) -> Canister

Execute deployment, assuming it should not fail. Panics if deployment fails.