Struct Config 

pub struct Config { /* private fields */ }

Represents a configuration object.

Start by creating a new Config object:

let config = Config::new("org.example.Demo", 1, None)?;

Provide an application name, a version and optionally a prefix, then, a new directory will be added to your filesystem, this is where all the created files will be stored in.

Write a file.

let config = Config::new("org.example.Demo", 1, None)?;
config.set_json("colors", json!({ "accent": "#7a7af9" }))?;

This wil store the file here: $HOME/.config/org.example.Demo/v1/colors.json

Get a file.

#[derive(Debug, Serialize, Deserialize)]
struct Colors { accent: String }
let settings: Colors = config.get_json("colors")?;

Implementations

impl Config

pub fn new(name: &str, version: u64, scope: Option<&str>) -> Result<Self, Error>

Creates a new Config object.

Arguments

• name - The name of the application.
• version - The version of the configuration.
• scope - An optional scope for the application.

Returns

A Result containing the new Config object or an Error if an error occurred.

Examples found in repository

examples/clean.rs (line 4)

fn main() -> Result<(), Error> {
    let config = Config::new("org.example.Demo", 1, None)?;
    config.clean()?;
    Ok(())
}

examples/set.rs (line 5)

fn main() -> Result<(), Error> {
    let config = Config::new("org.example.Demo", 1, None)?;
    config.set_json("colors", json!({ "accent": "#7a7af9" }))?;
    Ok(())
}

examples/get.rs (line 10)

fn main() -> Result<(), Error> {
    let config = Config::new("org.example.Demo", 1, None)?;
    let colors: Colors = config.get_json("colors")?;
    println!("{colors:?}");
    Ok(())
}

examples/scope.rs (line 11)

fn main() -> Result<(), Error> {
    let config = Config::new("org.example.Demo", 1, Some("appearance"))?;
    config.set_json("colors", json!({ "accent": "#7a7af9" }))?;
    let colors: Colors = config.get_json("colors")?;
    println!("{colors:?}");
    Ok(())
}

pub fn has_plain(&self, key: &str) -> bool

Determines if a plain file with the given key is present in the filesystem.

Arguments

• key - The key used to store the file.

Returns

true if the plain file exists, false otherwise.

pub fn has_json(&self, key: &str) -> bool

Determines if a json file with the given key is present in the filesystem.

Arguments

• key - The key used to store the file.

Returns

true if the json file exists, false otherwise.

pub fn get_json<T: DeserializeOwned>(&self, key: &str) -> Result<T, Error>

Gets the content of a json file with the given key and deserializes it into a type.

Arguments

• key - The key used to store the file.

Returns

A Result containing the deserialized value or an Error if an error occurred.

Examples found in repository

examples/get.rs (line 11)

fn main() -> Result<(), Error> {
    let config = Config::new("org.example.Demo", 1, None)?;
    let colors: Colors = config.get_json("colors")?;
    println!("{colors:?}");
    Ok(())
}

examples/scope.rs (line 13)

fn main() -> Result<(), Error> {
    let config = Config::new("org.example.Demo", 1, Some("appearance"))?;
    config.set_json("colors", json!({ "accent": "#7a7af9" }))?;
    let colors: Colors = config.get_json("colors")?;
    println!("{colors:?}");
    Ok(())
}

pub fn get_plain(&self, key: &str) -> Result<String, Error>

Gets the content of a plain file with the given key.

Arguments

• key - The key used to store the file.

Returns

A Result containing the value or an Error if an error occurred.

pub fn set_json<T: Serialize>(&self, key: &str, value: T) -> Result<(), Error>

Sets the content of a json file with the given key and serializes the value.

Arguments

• key - The key used to store the file.
• value - The value to be serialized and stored.

Returns

A Result indicating success or an Error if an error occurred.

Examples found in repository

examples/set.rs (line 6)

fn main() -> Result<(), Error> {
    let config = Config::new("org.example.Demo", 1, None)?;
    config.set_json("colors", json!({ "accent": "#7a7af9" }))?;
    Ok(())
}

examples/scope.rs (line 12)

fn main() -> Result<(), Error> {
    let config = Config::new("org.example.Demo", 1, Some("appearance"))?;
    config.set_json("colors", json!({ "accent": "#7a7af9" }))?;
    let colors: Colors = config.get_json("colors")?;
    println!("{colors:?}");
    Ok(())
}

pub fn set_plain(&self, key: &str, value: impl ToString) -> Result<(), Error>

Sets the content of a plain file with the given key.

Arguments

• key - The key used to store the file.
• value - String to write.

Returns

A Result indicating success or an Error if an error occurred.

pub fn path(&self, key: &str, file_type: FileType) -> Result<PathBuf, Error>

Given a key, returns the file path in the filesystem.

Arguments

• key - The key used to store the file.
• file_type - The file extension.

Returns

A Result containing the file path or an Error if an error occurred.

pub fn clean(&self) -> Result<(), Error>

Removes all files in the configuration path.

Returns

A Result containing the file path or an Error if an error occurred.

Examples found in repository

examples/clean.rs (line 5)

fn main() -> Result<(), Error> {
    let config = Config::new("org.example.Demo", 1, None)?;
    config.clean()?;
    Ok(())
}