Gitiles
Code Review Sign In
android-review.linaro.org / platform / external / rust / crates / config / d5a62418aef670f31eac5dc838083f11ba7075cc
commitd5a62418aef670f31eac5dc838083f11ba7075cc[log] [tgz]
authorJeongik Cha <jeongik@google.com>Wed Sep 27 11:05:44 2023 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Wed Sep 27 11:05:44 2023 +0000
tree1d8ee82a8ceb5276c1ae961bdb7c5b710966f685
parent919c1e4e74e1a5907ba6e6d75e4af0821df1e725 [diff]
parent576d980bd425fb34497c8908392d54167ee21841 [diff]
Import config am: 1bac1e0979 am: b663f4090b am: 886b4178e7 am: 576d980bd4

Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/config/+/2752271

Change-Id: I2a7e4a03b5a4658933eaa011a276bacd5916a27f
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
tree: 1d8ee82a8ceb5276c1ae961bdb7c5b710966f685
  1. .github/
  2. examples/
  3. src/
  4. tests/
  5. .cargo_vcs_info.json
  6. .clippy.toml
  7. .editorconfig
  8. .gitignore
  9. Android.bp
  10. Cargo.toml
  11. Cargo.toml.orig
  12. CHANGELOG.md
  13. LICENSE
  14. LICENSE-APACHE
  15. LICENSE-MIT
  16. METADATA
  17. MODULE_LICENSE_APACHE2
  18. MODULE_LICENSE_MIT
  19. OWNERS
  20. README.md
README.md

config-rs

Rust Build Status Crates.io Docs.rs

Layered configuration system for Rust applications (with strong support for 12-factor applications).

  • 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 )

Please note that this library can not be used to write changed configuration values back to the configuration file(s)!

Usage

[dependencies]
config = "0.13.1"

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_format example for more information.

More

See the documentation or examples for more usage information.

MSRV

We currently support Rust 1.56.0 and newer.

License

config-rs is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT for details.