Struct FileSource

pub struct FileSource<'p, T> { /* 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> = FileSource::new("cipherstash.toml");
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> =
    FileSource::new("cipherstash.toml")
        .optional();

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

Specifying a path

By default, the file is loaded from the current working directory. You can specify a path to the file using 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> =
    FileSource::new("cipherstash.toml")
        .with_path("some/place")
        .optional();

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

Using helper constants

The library provides two helper constants for the default configuration files:

• CIPHERSTASH_TOML: The standard configuration file for the client.
• CIPHERSTASH_SECRET_TOML: The secret configuration file for the client.

use cipherstash_client::config::{
     CIPHERSTASH_TOML,
     ZeroKMSConfigBuilder
};
let client = ZeroKMSConfigBuilder::default()
   .add_source(CIPHERSTASH_TOML)
   .build();

These constants can be chained with qualifiers such as optional.

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

See CipherStashConfigFile and CipherStashSecretConfigFile for details on the configuration files.

Implementations

impl<'p, T> FileSource<'p, T>

pub const fn new(filename: &'p str) -> Self

Create a new FileSource with the given filename. By default, the file is loaded from the current working directory.

pub fn optional(self) -> Self

Mark the source as optional. If the file is not found, the source will be ignored.

pub fn with_path(self, path: &'p str) -> Self

Set the path to the configuration file.

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

where T: DeserializeOwned,

Load the configuration from a file encoded in TOML format.

Trait Implementations

impl<B, T> ConfigSource<B> for FileSource<'_, T>

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

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

impl<'p, T: Debug> Debug for FileSource<'p, T>

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

Formats the value using the given formatter.