Expand description
Shared configuration helpers for Everruns crates.
everruns-config is a small leaf crate in the
Everruns ecosystem. It centralizes common
environment-variable loading patterns so services, workers, integrations,
and embedding hosts parse configuration the same way.
The API is intentionally function-based. Config structs across Everruns are heterogeneous, so composable helpers are clearer than a shared trait or derive macro.
§Example
use std::time::Duration;
use everruns_config::{env_bool, env_duration_secs, env_or, env_string};
let port = env_or("EVERRUNS_CONFIG_DOC_TEST_PORT", 8080_u16);
let bind_addr = env_string("EVERRUNS_CONFIG_DOC_TEST_BIND_ADDR", "127.0.0.1");
let enabled = env_bool("EVERRUNS_CONFIG_DOC_TEST_FEATURE_ENABLED", false);
let timeout = env_duration_secs(
"EVERRUNS_CONFIG_DOC_TEST_TIMEOUT_SECS",
Duration::from_secs(30),
);
assert_eq!(port, 8080);
assert_eq!(bind_addr, "127.0.0.1");
assert!(!enabled);
assert_eq!(timeout, Duration::from_secs(30));Enums§
- Config
Error - Errors that can occur when loading configuration from environment variables.
Functions§
- env_
bool - Read an env var as a
bool("true"or"1"), or returndefault. - env_
duration_ ms - Read an env var as a
Durationin milliseconds, or returndefault. - env_
duration_ secs - Read an env var as a
Durationin whole seconds, or returndefault. - env_
list - Read an env var as a comma-separated list of
T. Returns an empty vec if the var is unset or empty. Items that fail to parse are silently skipped. - env_opt
- Read an optional env var, parsing it to
T. ReturnsNoneif the var is unset or empty. - env_
opt_ string - Read an env var as a
String, or returnNoneif unset/empty. - env_
opt_ string_ any - Read the first non-empty env var from
vars. - env_or
- Read an env var, parse it to
T, or returndefault. - env_
required - Read a required env var, parsing it to
T. ReturnsErrif unset or unparseable. - env_
string - Read an env var as a
String, or returndefault. - env_
string_ any - Read the first non-empty env var from
vars, or returndefault.