Skip to main content

Crate everruns_config

Crate everruns_config 

Source
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§

ConfigError
Errors that can occur when loading configuration from environment variables.

Functions§

env_bool
Read an env var as a bool ("true" or "1"), or return default.
env_duration_ms
Read an env var as a Duration in milliseconds, or return default.
env_duration_secs
Read an env var as a Duration in whole seconds, or return default.
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. Returns None if the var is unset or empty.
env_opt_string
Read an env var as a String, or return None if 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 return default.
env_required
Read a required env var, parsing it to T. Returns Err if unset or unparseable.
env_string
Read an env var as a String, or return default.
env_string_any
Read the first non-empty env var from vars, or return default.