README.md

cargo-config2

Load and resolve Cargo configuration.

This library is intended to accurately emulate the actual behavior of Cargo configuration, for example, this supports the following behaviors:

• Hierarchical structure and merge
• Environment variables and relative paths resolution.
• target.<triple> and target.<cfg> resolution.

Supported tables and fields are mainly based on cargo-llvm-cov's use cases, but feel free to submit an issue if you see something missing in your use case.

Usage

Add this to your Cargo.toml:

[dependencies]
cargo-config2 = "0.1"

cargo-config2 is usually runnable with Cargo versions older than the Rust version required for build. (e.g., a cargo subcommand using cargo-config2 could work with older versions such as cargo +1.59 <subcommand>.)

Examples

// Read config files hierarchically from the current directory, merge them,
// apply environment variables, and resolve relative paths.
let config = cargo_config2::Config::load()?;
let target = "x86_64-unknown-linux-gnu";
// Resolve target-specific configuration (`target.<triple>` and `target.<cfg>`),
// and returns the resolved rustflags for `target`.
let rustflags = config.rustflags(target)?;
println!("{rustflags:?}");

See also the get example that partial re-implementation of cargo config get using cargo-config2.

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Third party software

This product includes copies and modifications of software developed by third parties:

• src/cfg_expr includes copies and modifications of cfg-expr crate by Embark Studios, licensed under "Apache-2.0 OR MIT".

See the license files included in these directories for more details.