Struct KopiaClientBuilder 

pub struct KopiaClientBuilder { /* private fields */ }

Builder for KopiaClient.

Implementations

impl KopiaClientBuilder

pub fn binary(self, binary: impl Into<PathBuf>) -> Self

Set the path to the kopia binary. Injectable so tests can point at a fake shim. Defaults to kopia (resolved via PATH).

pub fn env(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add an environment variable applied to every invocation. Use this for KOPIA_PASSWORD, KOPIA_CONFIG_PATH, cache dirs, and S3 credentials.

pub fn env_remove(self, key: impl Into<String>) -> Self

Record an environment variable to UNSET on every spawned command (Command::env_remove), mirroring the None half of the per-invocation overlay semantics (see run_with_env: Some(v) sets, None unsets). Use this to keep an ambient/inherited credential from leaking into a client that must not see it (e.g. the source KOPIA_PASSWORD on a destination-configured replication client). Applied AFTER Self::env, so a key both set and removed ends up unset; a later per-invocation overlay Some(v) still wins.

pub fn common_arg(self, arg: impl Into<String>) -> Self

Add a global arg applied (after the subcommand tokens) to every invocation. Must be a flag kopia accepts on every subcommand (e.g. a global flag); per-subcommand flags belong on the specific method. Prefer env vars (e.g. KOPIA_CHECK_FOR_UPDATES=false) for cross-cutting behavior.

pub fn default_timeout(self, timeout: Duration) -> Self

Default per-invocation timeout. None means no timeout.

pub fn build(self) -> KopiaClient

Finalize.

Trait Implementations

impl Clone for KopiaClientBuilder

fn clone(&self) -> KopiaClientBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KopiaClientBuilder

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

Formats the value using the given formatter.

impl Default for KopiaClientBuilder

fn default() -> KopiaClientBuilder

Returns the “default value” for a type.