Struct Config

pub struct Config { /* private fields */ }

Configuration structure to hold parsed values

Simple example:

#[cfg(features = "json")]
{
use ronf::{Config, File, FileFormat};
let config = Config::builder().add_file(File::new_str("test_file", FileFormat::Json, "{\"key\":
\"value\"}")).build().unwrap();
println!("\"key\": {}", config.get("key").unwrap());
}

Implementations

impl Config

pub fn builder() -> ConfigBuilder

Creates a ConfigBuilder

Examples found in repository

examples/basic.rs (line 4)

fn main() {
    let config = Config::builder()
        .add_file(File::new_str(
            "test_file",
            FileFormat::Json,
            "{\"key\": \"value\"}",
        ))
        .build()
        .unwrap();
    println!("\"key\": {}", config.get("key").unwrap());
}

examples/formats/json.rs (line 4)

fn main() {
    let config = Config::builder()
        .add_file(File::new_str(
            "test_file",
            FileFormat::Json,
            "{\"key\": \"value\"}",
        ))
        .build()
        .unwrap();
    println!("\"key\": {}", config.get("key").unwrap());
}

examples/changes.rs (line 4)

fn main() {
    let mut config = Config::builder()
        .add_file(File::new_str(
            "test_file",
            FileFormat::Json,
            "{\"key\": \"value\"}",
        ))
        .build()
        .unwrap();
    println!("\"key\": {}", config.get("key").unwrap());
    config.set("key", "another value".into());
    println!("\"key\" after change: {}", config.get("key").unwrap());
}

examples/saves.rs (line 6)

fn main() {
    let default_file = File::new_str("test_file", FileFormat::Json, "{\"key\": \"value\"}");
    let save = {
        let mut config = Config::builder()
            .add_file(default_file.clone())
            .build()
            .unwrap();
        println!("\"key\": {}", config.get("key").unwrap());
        config.set("key", "another value".into());
        println!("\"key\" after change: {}", config.get("key").unwrap());
        config.save(FileFormat::Json).unwrap()
    };

    let loaded_config = Config::builder()
        .add_file(default_file.clone())
        .load(File::new("save.json".to_string(), FileFormat::Json, save))
        .unwrap()
        .build()
        .unwrap();
    println!("\"key\" after load: {}", loaded_config.get("key").unwrap());
}

pub fn get(&self, key: &str) -> Option<&Value>

Get a value from config using a key

Examples found in repository

examples/basic.rs (line 12)

fn main() {
    let config = Config::builder()
        .add_file(File::new_str(
            "test_file",
            FileFormat::Json,
            "{\"key\": \"value\"}",
        ))
        .build()
        .unwrap();
    println!("\"key\": {}", config.get("key").unwrap());
}

examples/formats/json.rs (line 12)

fn main() {
    let config = Config::builder()
        .add_file(File::new_str(
            "test_file",
            FileFormat::Json,
            "{\"key\": \"value\"}",
        ))
        .build()
        .unwrap();
    println!("\"key\": {}", config.get("key").unwrap());
}

examples/changes.rs (line 12)

fn main() {
    let mut config = Config::builder()
        .add_file(File::new_str(
            "test_file",
            FileFormat::Json,
            "{\"key\": \"value\"}",
        ))
        .build()
        .unwrap();
    println!("\"key\": {}", config.get("key").unwrap());
    config.set("key", "another value".into());
    println!("\"key\" after change: {}", config.get("key").unwrap());
}

examples/saves.rs (line 10)

fn main() {
    let default_file = File::new_str("test_file", FileFormat::Json, "{\"key\": \"value\"}");
    let save = {
        let mut config = Config::builder()
            .add_file(default_file.clone())
            .build()
            .unwrap();
        println!("\"key\": {}", config.get("key").unwrap());
        config.set("key", "another value".into());
        println!("\"key\" after change: {}", config.get("key").unwrap());
        config.save(FileFormat::Json).unwrap()
    };

    let loaded_config = Config::builder()
        .add_file(default_file.clone())
        .load(File::new("save.json".to_string(), FileFormat::Json, save))
        .unwrap()
        .build()
        .unwrap();
    println!("\"key\" after load: {}", loaded_config.get("key").unwrap());
}

pub fn set(&mut self, key: &str, value: Value)

Set a value in config changes using a key

Examples found in repository

examples/changes.rs (line 13)

fn main() {
    let mut config = Config::builder()
        .add_file(File::new_str(
            "test_file",
            FileFormat::Json,
            "{\"key\": \"value\"}",
        ))
        .build()
        .unwrap();
    println!("\"key\": {}", config.get("key").unwrap());
    config.set("key", "another value".into());
    println!("\"key\" after change: {}", config.get("key").unwrap());
}

examples/saves.rs (line 11)

fn main() {
    let default_file = File::new_str("test_file", FileFormat::Json, "{\"key\": \"value\"}");
    let save = {
        let mut config = Config::builder()
            .add_file(default_file.clone())
            .build()
            .unwrap();
        println!("\"key\": {}", config.get("key").unwrap());
        config.set("key", "another value".into());
        println!("\"key\" after change: {}", config.get("key").unwrap());
        config.save(FileFormat::Json).unwrap()
    };

    let loaded_config = Config::builder()
        .add_file(default_file.clone())
        .load(File::new("save.json".to_string(), FileFormat::Json, save))
        .unwrap()
        .build()
        .unwrap();
    println!("\"key\" after load: {}", loaded_config.get("key").unwrap());
}

pub fn list(&self) -> Vec<String>

List all keys in the config

pub fn save(&self, format: FileFormat) -> Result<String, String>

Save the current configuration to a file in the specified format

Examples found in repository

examples/saves.rs (line 13)

fn main() {
    let default_file = File::new_str("test_file", FileFormat::Json, "{\"key\": \"value\"}");
    let save = {
        let mut config = Config::builder()
            .add_file(default_file.clone())
            .build()
            .unwrap();
        println!("\"key\": {}", config.get("key").unwrap());
        config.set("key", "another value".into());
        println!("\"key\" after change: {}", config.get("key").unwrap());
        config.save(FileFormat::Json).unwrap()
    };

    let loaded_config = Config::builder()
        .add_file(default_file.clone())
        .load(File::new("save.json".to_string(), FileFormat::Json, save))
        .unwrap()
        .build()
        .unwrap();
    println!("\"key\" after load: {}", loaded_config.get("key").unwrap());
}

Trait Implementations

impl Display for Config

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

Formats the value using the given formatter.