Struct ZeroKMSConfigBuilder

pub struct ZeroKMSConfigBuilder { /* private fields */ }

Implementations

impl ZeroKMSConfigBuilder

pub fn add_source<S>(self, source: S) -> Self

where S: ConfigSource<Self> + 'static,

Add a configuration source to the builder. Any source that implements ConfigSource can be added to the builder.

The sources are applied in LIFO order, so the last source added will be the first to be applied. This means that the first source added will take precedence over sources added later.

Example

use cipherstash_client::config::{ZeroKMSConfigBuilder, EnvSource, CIPHERSTASH_TOML};

let builder = ZeroKMSConfigBuilder::default()
    // Environment variables "win"
    .add_source(EnvSource::default())
    .add_source(CIPHERSTASH_TOML);

let config = builder.build().expect("failed to build config");

pub fn build(self) -> Result<ZeroKMSConfig, ConfigError>

pub fn build_auth_config(&self) -> Result<ZeroKMSAuthConfig, ConfigError>

pub fn build_with_client_key( self, ) -> Result<ZeroKMSConfigWithClientKey, ConfigError>

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

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

pub fn config_dir(self, value: &str) -> Self

pub fn console_config(self, value: &ConsoleConfig) -> Self

pub fn cts_config(self, value: &CtsConfig) -> Self

pub fn workspace_id(self, value: &str) -> Self

pub fn decryption_log(self, value: bool) -> Self

pub fn try_with_client_id(self, client_id: &str) -> Result<Self, ConfigError>

Try to parse the given string as a UUID and set it as the client ID.

pub fn try_with_client_key(self, client_key: &str) -> Result<Self, ConfigError>

Try to parse the given string as a ClientKey and set it on the builder.

pub fn client_id(self, client_id: &str) -> Self

👎Deprecated since 0.16.0: Use try_with_client_id instead

Sets the client ID. Panics if the client ID is not a valid UUID. Use Self::try_with_client_id to handle the error.

pub fn client_key(self, value: &str) -> Self

👎Deprecated since 0.16.0: Use try_with_client_key instead

Parses and sets the client key. Panics if the client key is not valid. Use Self::try_with_client_key to handle the error.

pub fn with_env(self) -> Self

👎Deprecated since 0.16.0: Use add_source instead

Hydrate the configuration using environment variables

Trait Implementations

impl ConfigSource<ZeroKMSConfigBuilder> for CipherStashConfigFile

fn add_to_builder( &self, builder: ZeroKMSConfigBuilder, ) -> Result<ZeroKMSConfigBuilder, ConfigError>

impl ConfigSource<ZeroKMSConfigBuilder> for CipherStashSecretConfigFile

fn add_to_builder( &self, builder: ZeroKMSConfigBuilder, ) -> Result<ZeroKMSConfigBuilder, ConfigError>

impl ConfigSource<ZeroKMSConfigBuilder> for EnvSource

Adds env vars relevant to ZeroKMS to the builder.

fn add_to_builder( &self, builder: ZeroKMSConfigBuilder, ) -> Result<ZeroKMSConfigBuilder, ConfigError>

impl Default for ZeroKMSConfigBuilder

fn default() -> ZeroKMSConfigBuilder

Returns the “default value” for a type.