Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rust-cli/config-rs
⚙️ Layered configuration system for Rust applications (with strong support for 12-factor applications).
https://github.com/rust-cli/config-rs
config config-management configuration configuration-management json rust toml
Last synced: 5 days ago
JSON representation
⚙️ Layered configuration system for Rust applications (with strong support for 12-factor applications).
- Host: GitHub
- URL: https://github.com/rust-cli/config-rs
- Owner: rust-cli
- License: apache-2.0
- Created: 2017-01-24T03:24:15.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-12-20T16:33:23.000Z (22 days ago)
- Last Synced: 2024-12-30T23:00:09.298Z (12 days ago)
- Topics: config, config-management, configuration, configuration-management, json, rust, toml
- Language: Rust
- Homepage: https://docs.rs/config/latest/config/
- Size: 1 MB
- Stars: 2,712
- Watchers: 20
- Forks: 220
- Open Issues: 126
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE
Awesome Lists containing this project
- fucking-awesome-rust - rust-cli/config-rs - Layered configuration system (with strong support for 12-factor applications). (Libraries / Configuration)
- awesome-rust - rust-cli/config-rs - Layered configuration system (with strong support for 12-factor applications). (Libraries / Configuration)
- trackawesomelist - rust-cli/config-rs (⭐2.6k) - Layered configuration system (with strong support for 12-factor applications). (Recently Updated / [Oct 31, 2024](/content/2024/10/31/README.md))
README
# config-rs
[](https://travis-ci.org/mehcode/config-rs)
[](https://crates.io/crates/config)
[](https://docs.rs/config)
> Layered configuration system for Rust applications (with strong support for [12-factor] applications).
[12-factor]: https://12factor.net/config
- Set defaults
- Set explicit values (to programmatically override)
- Read from [JSON], [TOML], [YAML], [INI], [RON], [JSON5] files
- Read from environment
- Loosely typed — Configuration values may be read in any supported type, as long as there exists a reasonable conversion
- Access nested fields using a formatted path — Uses a subset of JSONPath; currently supports the child ( `redis.port` ) and subscript operators ( `databases[0].name` )
[JSON]: https://github.com/serde-rs/json
[TOML]: https://github.com/toml-lang/toml
[YAML]: https://github.com/Ethiraric/yaml-rust2
[INI]: https://github.com/zonyitoo/rust-ini
[RON]: https://github.com/ron-rs/ron
[JSON5]: https://github.com/callum-oakley/json5-rs
Please note that this library can not be used to write changed configuration
values back to the configuration file(s)!
## Usage
```toml
[dependencies]
config = "0.14.0"
```
### Feature flags
- `ini` - Adds support for reading INI files
- `json` - Adds support for reading JSON files
- `yaml` - Adds support for reading YAML files
- `toml` - Adds support for reading TOML files
- `ron` - Adds support for reading RON files
- `json5` - Adds support for reading JSON5 files
### Support for custom formats
Library provides out of the box support for most renowned data formats such as JSON or Yaml. Nonetheless, it contains an extensibility point - a `Format` trait that, once implemented, allows seamless integration with library's APIs using custom, less popular or proprietary data formats.
See [custom_file_format](https://github.com/mehcode/config-rs/tree/master/examples/custom_file_format) example for more information.
### More
See the [documentation](https://docs.rs/config) or [examples](https://github.com/mehcode/config-rs/tree/master/examples) for
more usage information.
## License
Licensed under either of
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or )
* MIT license ([LICENSE-MIT](LICENSE-MIT) or )
at your option.