Adding `optify` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add optify

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

optify = "0.20.5"

The optify library will be automatically available globally. Read the optify library documentation.

Back to the crate overview.

Readme

Optify in Rust

The core implementation of Optify in Rust. Simplifies getting the right configuration options for a process using pre-loaded configurations from files (JSON, YAML, etc.) to manage options for experiments or flights.

See tests for examples and tests for different implementations of this format for managing options.

See the root README.md for more information and examples.

⚠️ Development in progress ⚠️
APIs are not final and may change, for example, names may change. This is just meant to be minimal to get started and help build Python and Ruby libraries.

How It Works

The config crate (library) is used to help load configuration files. This allows us to load many different types of files, including JSON, JSON5, YAML, and more. We no longer use the config crate to combine configuration files because it was slower to merge them and deserialize the result than our custom merging logic since we know that we want to use serde_json::Values.

We merge configurations starting with the first one given and thus the final feature overrides the previous ones. We may try to optimize further in the future, but this is fine now when there are just a few features or imports and when keys are mostly unique.

Optionally, when working locally, there is support to watch for changes to the configuration files and folders using the notify-debouncer-full crate (library).

Testing

Run:

cargo test

Formatting

To automatically change code, run:

cargo fmt && cargo clippy --fix --allow-dirty --allow-staged

Benchmarking

Run:

cargo build --release
cargo bench

# Run one specific benchmark, example:
cargo bench --bench get_options_benchmark

# Open one of the reports
open target/criterion/*/report/index.html

Publishing

cargo login
cargo publish

Adding optify library as a dependency

Adding `optify` library as a dependency