vconfig

Crates.iovconfig
lib.rsvconfig
version0.1.2
created_at2025-07-31 23:31:50.527193+00
updated_at2025-08-06 17:19:42.237457+00
descriptionA native Rust decoder of TOML-formatted like files/streams. Provides implementations of deserializing TOML-formatted like files/streams to Rust structures with variant context.
homepagehttps://github.com/gu-wei-x/vconfig
repositoryhttps://github.com/gu-wei-x/vconfig
max_upload_size
id1775877
size96,661
Wei Gu (gu-wei-x)

documentation

README

vconfig

github crates.io docs.rs build status

vconfig is a crate to deserialize Rust data from TOML-formatted like files/streams based on variant context.

use std::error::Error;
use vconfig::default::DefaultVariants;
use vconfig::serde::Deserialize;
use vconfig::traits::Variants;

#[derive(Debug, Deserialize, PartialEq)]
#[serde(crate = "vconfig::serde")]
struct Config {
    key1: String,
    key2: u64,
}

fn main() -> Result<(), Box<dyn Error>> {
    from_str()?;
    from_file()?;
    Ok(())
}

fn from_str() -> Result<(), Box<dyn Error>> {
    let raw_str = r#"
        key1&variant1:v1 = "v1"
        key1 = "v2"
        key2&variant2:v2 = "5"
        key2 = "3"
    "#;
    let mut variants = DefaultVariants::default();
    _ = variants.add("variant1", "v1");
    _ = variants.add("variant2", "v2");
    let result = vconfig::de::from_str::<Config, _>(raw_str, &variants);
    println!("{:?}", result); // Ok(Config { key1: "v1", key2: 5 })
    assert_eq!(
        result,
        Ok(Config {
            key1: "v1".to_string(),
            key2: 5
        })
    );
    Ok(())
}

fn from_file() -> Result<(), Box<dyn Error>> {
    let mut variants = DefaultVariants::default();
    _ = variants.add("variant1", "v1");
    _ = variants.add("variant2", "v2");
    let result = vconfig::de::from_file::<Config, _, _>("basic.toml", &variants);
    println!("{:?}", result); // Ok(Config { key1: "v1", key2: 5 })
    assert_eq!(
        result,
        Ok(Config {
            key1: "v1".to_string(),
            key2: 5
        })
    );
    Ok(())
}
Commit count: 0

cargo fmt