Struct FileSource 

pub struct FileSource<T, const REQUIRED: bool = true>(/* private fields */);

Specifies a configuration source that reads from a file and deserializes it into a type, T.

Example

use cipherstash_client::config::{
    CipherStashConfigFile,
    FileSource,
    ZeroKMSConfigBuilder
};

let source = FileSource::<CipherStashConfigFile>::default();
let client = ZeroKMSConfigBuilder::default()
    .add_source(source)
    .build();

Optional files

Normally, if the file is not found, the source will return an error. You can mark the source as optional to ignore the error.

let source = FileSource::<CipherStashConfigFile>::default().optional();
let client = ZeroKMSConfigBuilder::default()
    .add_source(source)
    .build();

Alternatively, you can specify that a file is required using the REQUIRED type parameter:

let source = FileSource::<CipherStashConfigFile, true>::default();

Specifying a path

By default, the file is loaded from the current working directory. You can specify the directory path with the with_path method. You can chain the optional method to mark the source as optional.

// Load the file from `some/place/cipherstash.toml`
// Ignore if the file is not found
let source = FileSource::<CipherStashConfigFile>::default()
    .with_path("some/place")
    .optional();

let client = ZeroKMSConfigBuilder::default()
    .add_source(source)
    .build();

Specifying a filename

You can also specify the filename to use with the with_filename method.

// Load the file from `some/place/myconfig.toml`
let source = FileSource::<CipherStashConfigFile>::default()
   .with_filename("myconfig.toml");

Built in file sources

The following built-in file sources are available:

• [CipherStashConfigFile]: Loads the cipherstash.toml file.
• [CipherStashSecretConfigFile]: Loads the cipherstash_secret.toml file.
• [LocalConfigSource]: Loads the config.toml file normally found in ~/.cipherstash/.

See [CipherStashConfigFile] and [CipherStashSecretConfigFile] for details on the configuration files.

Custom file sources

To create a custom file source, implement the IntoFileSource trait.

use cipherstash_client::config::{IntoFileSource, FileSource};
use std::path::PathBuf;
use cts_common::Crn;
use serde::{Deserialize, Serialize};

#[derive(Debug, Serialize, Deserialize)]
pub struct MyConfig {
    workspace_crn: Crn,
}

impl IntoFileSource for MyConfig {
    fn default_path() -> PathBuf {
        PathBuf::from("~/.cipherstash/")
    }

    fn filename() -> String {
        "myconfig.toml".to_string()
    }
}

// The `ConfigSource` trait must also be implemented for any builder type you want to use.
use cipherstash_client::config::{ConfigError, ConfigSource, ZeroKMSConfigBuilder};

impl ConfigSource<ZeroKMSConfigBuilder> for MyConfig {
   fn add_to_builder(&self, builder: ZeroKMSConfigBuilder) -> Result<ZeroKMSConfigBuilder, ConfigError> {
       Ok(builder.workspace_crn(self.workspace_crn.clone()))
  }
}

Implementations

impl<T, const REQUIRED: bool> FileSource<T, REQUIRED>

where T: IntoFileSource,

pub fn save(&self, value: T) -> Result<(), ConfigError>

where T: Serialize,

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

Specify the path of the file to load instead of the one returned via IntoFileSource::default_path.

Example

use cipherstash_client::config::{FileSource, UserConfigSource};

FileSource::<UserConfigSource>::default()
    .with_path("some_dir/myconfig.toml");

pub fn with_path_opt(self, path: Option<impl Into<PathBuf>>) -> Self

Like Self::with_path, but allows the path to be optional.

pub fn with_filename(self, filename: impl Into<String>) -> Self

impl<T> FileSource<T, true>

pub fn load(&self) -> Result<T, ConfigError>

where T: IntoFileSource + DeserializeOwned,

pub fn optional(self) -> FileSource<T, false>

Converts the source to an optional source.

impl<T> FileSource<T, false>

pub fn load_opt(&self) -> Result<Option<T>, ConfigError>

where T: IntoFileSource + DeserializeOwned,

pub fn required(self) -> FileSource<T, true>

Converts the source to a required source.

Trait Implementations

impl<B, T> ConfigSource<B> for FileSource<T, true>

where T: ConfigSource<B> + IntoFileSource + DeserializeOwned,

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

impl<B, T> ConfigSource<B> for FileSource<T, false>

where T: ConfigSource<B> + IntoFileSource + DeserializeOwned,

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

impl<T: Debug, const REQUIRED: bool> Debug for FileSource<T, REQUIRED>

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

Formats the value using the given formatter.

impl<T, const REQUIRED: bool> Default for FileSource<T, REQUIRED>

fn default() -> Self

Returns the “default value” for a type.