op_config/
lib.rs

1#![doc = include_str!("../README.md")]
2#![warn(
3    missing_debug_implementations,
4    missing_docs,
5    unreachable_pub,
6    rustdoc::all
7)]
8#![deny(unused_must_use, rust_2018_idioms)]
9#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
10
11/// Stack Configuration
12///
13/// The [stack] module contains the core [Config] struct which is
14/// responsible for holding the configuration of the OP stack.
15///
16/// ## Example
17///
18/// ```rust
19/// use std::path::PathBuf;
20/// use op_config::Config;
21///
22/// let config = Config::default();
23/// assert_eq!(config.artifacts, PathBuf::from(Config::STACK_DIR_NAME));
24/// ```
25pub mod stack;
26pub use stack::*;
27
28/// [StageConfig] is a [figment::Provider] that holds the [Stage] configuration.
29pub mod stages;
30
31/// Providers are [figment::Provider]s used to retrieve configuration.
32pub mod providers;
33
34/// A wrapper for the root path used during toml config detection.
35pub mod root;
op_config/lib.rs

op_config/
lib.rs
