Enum ConfigSource

pub enum ConfigSource<P, T> {
    File {
        path: P,
    },
    Memory {
        values: T,
    },
    Empty,
}

Source for pict-rs configuration when embedding as a library

Variants

File

A File source for pict-rs configuration

Fields

path: P

Memory

An in-memory source for pict-rs configuration

Fields

values: T

Empty

No configuration

Implementations

impl<T> ConfigSource<PathBuf, T>

where T: Serialize,

pub fn memory(values: T) -> Self

Create a new memory source

impl<P> ConfigSource<P, ()>

where P: AsRef<Path>,

pub fn file(path: P) -> Self

Create a new file source

impl ConfigSource<PathBuf, ()>

pub fn empty() -> Self

Create a new empty source

impl<P: AsRef<Path>, T: Serialize> ConfigSource<P, T>

pub fn init<Q: AsRef<Path>>( self, save_to: Option<Q>, ) -> Result<PictRsConfiguration>

Initialize the pict-rs configuration

This takes an optional config_file path which is a valid pict-rs configuration file, and an optional save_to path, which the generated configuration will be saved into. Since many parameters have defaults, it can be useful to dump a valid configuration with default values to see what is available for tweaking.

When running pict-rs as a library, configuration is limited to environment variables and configuration files. Commandline options are not available.

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let configuration = pict_rs::ConfigSource::memory(serde_json::json!({
        "server": {
            "address": "127.0.0.1:8080",
            "temporary_directory": "/tmp/t1"
        },
        "repo": {
            "type": "sled",
            "path": "./sled-repo"
        },
        "store": {
            "type": "filesystem",
            "path": "./files"
        }
    })).init::<&str>(None)?;

    Ok(())
}