https://github.com/jwodder/cfgfifo

(De)serialize common configuration file formats based on file extension
https://github.com/jwodder/cfgfifo

available-on-crates-io configuration data-serialization file-formats json json5 ron rust serde toml yaml

Last synced: 20 days ago
JSON representation

(De)serialize common configuration file formats based on file extension

• Host: GitHub
• URL: https://github.com/jwodder/cfgfifo
• Owner: jwodder
• License: mit
• Created: 2023-10-29T17:51:43.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-10-07T07:32:57.000Z (about 1 month ago)
• Last Synced: 2024-10-13T10:55:43.993Z (about 1 month ago)
• Topics: available-on-crates-io, configuration, data-serialization, file-formats, json, json5, ron, rust, serde, toml, yaml
• Language: Rust
• Homepage:
• Size: 68.4 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

[![CI Status](https://github.com/jwodder/cfgfifo/actions/workflows/test.yml/badge.svg)](https://github.com/jwodder/cfgfifo/actions/workflows/test.yml)

[![codecov.io](https://codecov.io/gh/jwodder/cfgfifo/branch/master/graph/badge.svg)](https://codecov.io/gh/jwodder/cfgfifo)

[![Minimum Supported Rust Version](https://img.shields.io/badge/MSRV-1.70-orange)](https://www.rust-lang.org)

[![MIT License](https://img.shields.io/github/license/jwodder/cfgfifo.svg)](https://opensource.org/licenses/MIT)

[GitHub](https://github.com/jwodder/cfgfifo) | [crates.io](https://crates.io/crates/cfgfifo) | [Documentation](https://docs.rs/cfgfifo) | [Issues](https://github.com/jwodder/cfgfifo/issues) | [Changelog](https://github.com/jwodder/cfgfifo/blob/master/CHANGELOG.md)

`cfgfifo` is a Rust library for serializing & deserializing various common

configuration file formats ([JSON][], [JSON5][], [RON][], [TOML][], and

[YAML][]), including autodetecting the format of a file based on its file

extension.  It's good for application authors who want to support multiple

configuration file formats but don't want to write out a bunch of boilerplate.

`cfgfifo` has already written that boilerplate for you, so let it (de)serialize

your files!

[JSON]: https://www.json.org

[JSON5]: https://json5.org

[RON]: https://github.com/ron-rs/ron

[TOML]: https://toml.io

[YAML]: https://yaml.org

Example

=======

```rust

use serde::Deserialize;

#[derive(Clone, Debug, Deserialize, Eq, PartialEq)]

struct AppConfig {

    #[serde(default)]

    enable_foo: bool,

    #[serde(default)]

    bar_type: BarType,

    #[serde(default)]

    flavor: Option,

}

#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)]

enum BarType {

    #[default]

    Open,

    Closed,

    Clopen,

}

fn main() -> anyhow::Result<()> {

    let Some(cfgpath) = std::env::args().nth(1) else {

        anyhow::bail!("No configuration file specified");

    };

    // cfgfifo identifies the format used by the file `cfgpath` based on its

    // file extension and deserializes it appropriately:

    let cfg: AppConfig = cfgfifo::load(cfgpath)?;

    println!("You specified the following configuration:");

    println!("{cfg:#?}");

    Ok(())

}

```