Struct cipherstash_client::config::Config

pub struct Config { /* private fields */ }

The main data structure used for interacting with client configuration.

This structure is guaranteed to contain all necessary parameters for interacting with the CipherStash Data Service.

Implementations

impl Config

pub fn load(opts: LoadOpts) -> Result<Self, ConfigError>

Loads and returns configuration for a CipherStash client.

This function respects the behaviour documented in the CipherStash configuration docs. Configuration parameters may be defined in any location (i.e. a JSON configuration file, environment variables, or an argument to this function call). Configuration at any specific level is not required (e.g. a JSON configuration file is not required) as long as the minimum amount of configuration can be resolved across all levels.

load optionally accepts a profile_name and config_path for specifying where to look for configuration files. Note that config_path is the root of all CipherStash config and that the path for profile-config.json files is resolved as <config_path>/<profile_name>/profile-config.json. If not provided, profile_name defaults to "default" and config_path defaults to ~/.cipherstash. If profile_name is provided and profile-config.json does not exist for the profile, load will fail and return an error.

pub async fn create_profile(
    workspace: String,
    region: String,
    profile_name: Option<String>,
    force: bool
) -> Result<PathBuf, ConfigError>

pub fn data_service_credentials_provider(
    &self
) -> Box<dyn AsyncAccessor<Value = DataServiceCredentials, Error = StdError>>

pub fn key_provider(&self) -> Box<dyn KeyProvider>

pub fn naming_key_provider(
    &self
) -> Box<dyn AsyncAccessor<Value = Vec<u8>, Error = GetNamingKeyError>>

pub fn create_client(
    &self
) -> Result<Stash<Channel, NativeClientData>, CreateClientError>

pub fn endpoint(&self) -> String

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.

impl PartialEq<Config> for Config

fn eq(&self, other: &Config) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Config