All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
This is a maintenance release, mostly to get some dependency updates out, but also with some fixes and changes that have piled up over a rather long time.
- #100 Fix #99: expose file::source::FileSource
- #318 Add Value::origin()
- #379 Add clone to builder state types
- #381 env: add a 'convert_case' field to ease dealing with kebab-case
- #402 Gate async-traits behind a feature
- #413 Attach key to type error generated from Config::get_()
- #480 Hide and deprecate AsyncConfigBuilder
- #306 fix: dot in config name
- #334 errors: clarify names of integer types
- #343 fix yaml to parse int keys
- #353 Use TryInto for more permissive deserialization for integers
- #354 Fix uppercase lowercase isses
- #374 Fix FIXME in de.rs and value.rs
- #395 Fix: Do not use deprecated function
- #429 Make the parse list key to lowercase when insert the keys
- #465 Fix nested arrays (by reworking array handling)
- #481 Fix docs warnings
- #271 Update warp requirement from =0.3.1 to =0.3.2
- #316 test: Adopt test-env to fix random test failure
- #335 Update MSRV: 1.56.0 -> 1.56.1
- #350 Bump actions/checkout from 2.4.0 to 3.0.2
- #367 Update ron requirement from 0.7 to 0.8
- #373 Update notify (4.0.0 -> 5.0.0)
- #375 Update temp-env requirement from 0.2.0 to 0.3.0
- #378 Update warp requirement from =0.3.2 to =0.3.3
- #382 Bump actions/checkout from 3.0.2 to 3.1.0
- #389 Update MSRV: 1.56.1 -> 1.59.0
- #403 Bump actions/checkout from 3.1.0 to 3.2.0
- #411 Bump actions/checkout from 3.2.0 to 3.3.0
- #420 Update MSRV: 1.59.0 -> 1.60.0
- #421 Update toml requirement from 0.5 to 0.7
- #422 Update MSRV in cron workflow
- #425 Bump actions/checkout from 3.3.0 to 3.4.0
- #426 Update MSRV: 1.60.0 -> 1.64.0
- #427 Bump actions/checkout from 3.4.0 to 3.5.0
- #430 Update warp requirement from =0.3.3 to =0.3.4
- #433 Bump actions/checkout from 3.5.0 to 3.5.1
- #434 Bump actions/checkout from 3.5.1 to 3.5.2
- #436 Update warp requirement from =0.3.4 to =0.3.5
- #437 Update rust-ini requirement from 0.18 to 0.19
- #438 Update notify requirement from ^5.0.0 to ^6.0.0
- #440 Bump actions/checkout from 3.5.2 to 3.5.3
- #441 Update indexmap requirement from 1.7.0 to 2.0.0
- #451 Bump actions/checkout from 3.5.3 to 3.6.0
- #453 Bump actions/checkout from 3.6.0 to 4.0.0
- #455 MSRV: 1.64.0 -> 1.66.0
- #456 Update toml requirement from 0.7 to 0.8
- #458 Update MSRV in cron job
- #459 Bump actions/checkout from 4.0.0 to 4.1.0
- #462 Update warp requirement from =0.3.5 to =0.3.6
- #477 Bump actions/checkout from 4.1.0 to 4.1.1
- #483 Update MSRV: 1.66.0 -> 1.70.0
- #503 Bump actions/setup-python from 4 to 5
- #188 Add test for log::Level deserialization
- #274 move 'must_use' attribute to struct for 'builder' types
- #283 Add cron job
- #299 docs(builder): fix typo in doc comment
- #344 Fix clippy: Derive Eq as well
- #347 Fix clippy: use first() instead of get(0)
- #348 actions: Remove "minimal" setting, as workflow does not support this key
- #356 refactoring deserialize-any in config
- #359 Add test to deserialize unsigned int
- #360 Duplicate test for type conversion with unsigned int
- #362 Run clippy only on MSRV
- #363 Backport CHANGELOG entry for 0.13.2
- #388 Add documentation to File required setter
- #392 Add simple example using lazy_static
- #393 More clippy fixes
- #396 Replace actions rs
- #401 Backport changelog
- #404 Replace fixupmerge with gitlint
- #406 Fix clippy: Remove unnecessary cast
- #410 Copy member docs to builder functions
- #416 Replace actions-rs with run scripts
- #423 Fix clippy: Remove needless borrowed reference
- #445 Update license field following SPDX 2.1 license expression standard
- #460 Use weak features for preserve_order
- #469 chore: Use a common method in parsers to check root is a table
- #471 Clippy exact toolchains
- #479 docs: Example for conditionally loading sources
- #485 Add DCO
- #488 Unify deser impl (redux)
- #489 deserialize: strings: Introduce string_serialize_via_display macro
- #507 Check external types
- #511 Fix: cargo-check-external-types must use nightly 2023-10-10
Please note that we had to update the MSRV for this crate from 1.56.0 to 1.59.0 for this patch release being possible, because a transitive dependency did update its MSRV.
- Backport of commit d54986c54091e4620c199d3dfadde80b82958bb3 from #362 for using float_cmp for testing floats
- Backport of #379 adding
Clone
trait derive to builder states
- Backport of #316 to be testing with temp_env. The backport was necessary to be able to backport the next change. This change shouldn't be user-visible.
- Backport of #353 to use TryInto for more permissive deserialization of integers
- Backport of commit 518a3cafa1e62ba7405709e5c508247e328e0a18 from #362 to fix tests
- Prefix-Seperator support was added #292
- Environment lists can now be parsed #255
- Setting an overwrite from an Option was added #303
- Option to keep the prefix from an environment variable was added #298
- Some small doc/CI fixes #307, #309
- MSRV was updated to 1.56.0 #304
- Dependencies were updated #289, #301
- A new ConfigBuilder interface for building configuration objects #196
- Asynchronous sources #207
- Custom ENV separators are now supported #185
- Loads of dependency updates and bugfixes of course
- Preserved map order #217
- Support for parsing numbers from the environment #137
- Support for unsigned integers #178
Format
trait for (custom) file formats #219
Environment::new()
- see #235- Large parts of the
Config
interface - see #196Config::merge()
Config::with_merged()
Config::refresh()
Config::set_default()
Config::set()
Config::set_once()
Config::deserialize()
- The
Config
type got a builder-patternwith_merged()
method #166. - A
Config::set_once()
function was added, to set an value that can be overwritten byConfig::merge
ing another configuration #172 - serde_hjson is, if enabled, pulled in without default features. This is due to a bug in serde_hjson, see #169 for more information.
- Testing is done on github actions #175
- Allow enums as configuration keys #119
- Remove lowercasing of keys (unless the key is coming from an environment variable).
- Update nom to 5.x
- Support deserializing to a struct with
#[serde(default)]
#106
- Support reading
enum
s from configuration. #85 - Improvements to error path (attempting to propagate path). #89
- Fix UB in monomorphic expansion. We weren't re-exporting dependent types. #91
- Allow Environment variable collection to ignore empty values. #78
// Empty env variables will not be collected Environment::with_prefix("APP").ignore_empty(true)
-
Breaking Change: Environment does not declare a separator by default.
// 0.8.0 Environment::with_prefix("APP") // 0.9.0 Environment::with_prefix("APP").separator("_")
-
Add support for INI. #72
-
Add support for newtype structs. #71
-
Fix bug with array set by path. #69
-
Update to nom 4. #63
- Update lazy_static and yaml_rust
- Be compatible with nom's verbose_errors feature (#50)[rust-cli#50]
- Add
derive(PartialEq)
for Value (#54)[rust-cli#54]
- Fix conflict with
serde_yaml
. #39
-
Implement
Source
forConfig
. -
Implement
serde::de::Deserializer
forConfig
.my_config.deserialize
may now be called as eitherDeserialize::deserialize(my_config)
ormy_config.try_into()
. -
Remove
ConfigResult
. The builder pattern requires either.try_into
as the final step or the initialConfig::new()
to be bound to a slot. Errors must also be handled on each call instead of at the end of the chain.let mut c = Config::new(); c .merge(File::with_name("Settings")).unwrap() .merge(Environment::with_prefix("APP")).unwrap();
let c = Config::new() .merge(File::with_name("Settings")).unwrap() .merge(Environment::with_prefix("APP")).unwrap() // LLVM should be smart enough to remove the actual clone operation // as you are cloning a temporary that is dropped at the same time .clone();
let mut s: Settings = Config::new() .merge(File::with_name("Settings")).unwrap() .merge(Environment::with_prefix("APP")).unwrap() .try_into();
-
Implement
Source
forVec<T: Source>
andVec<Box<Source>>
Config::new() .merge(vec![ File::with_name("config/default"), File::with_name(&format!("config/{}", run_mode)), ])
-
Implement
From<&Path>
andFrom<PathBuf>
forFile
-
Remove
namespace
option for File -
Add builder pattern to condense configuration
Config::new() .merge(File::with_name("Settings")) .merge(Environment::with_prefix("APP")) .unwrap()
-
Parsing errors even for non required files – @Anthony25 ( #33 )
- Added config category to Cargo.toml
config.get
has been changed to take a type parameter and to deserialize into that type using serde. Old behavior (get a value variant) can be used by passingconfig::Value
as the type parameter:my_config.get::<config::Value>("..")
. Some great help here from @impowski in #25.- Propagate parse and type errors through the deep merge (remembering filename, line, etc.)
- Remove directory traversal on
File
. This is likely temporary. I do want this behavior but I can see how it should be optional. See #35 - Add
File::with_name
to get automatic file format detection instead of manualFileFormat::*
– @JordiPolo - Case normalization #26
- Remove many possible panics #8
my_config.refresh()
will do a full re-read from the source so live configuration is possible with some work to watch the file
-
Remove global (
config::get
) API — It's now required to create a local configuration instance withconfig::Config::new()
first.If you'd like to have a global configuration instance, use
lazy_static!
as follows:use std::sync::RwLock; use config::Config; lazy_static! { static ref CONFIG: RwLock<Config> = Default::default(); }
- YAML from @tmccombs
- Nested field retrieval
- Deep merging of sources (was shallow)
config::File::from_str
to parse and merge a file from a string- Support for retrieval of maps and slices —
config::get_table
andconfig::get_array
Initial release.