Struct Settings 

pub struct Settings {

    pub database_url: String,
    pub databases: HashMap<String, String>,
    pub max_form_body_bytes: Option<usize>,
    pub db_max_connections: u32,
    pub db_acquire_timeout_secs: u64,
    pub db_min_connections: u32,
    pub db_idle_timeout_secs: Option<u64>,
    pub db_max_lifetime_secs: Option<u64>,
    pub db_test_before_acquire: bool,
    pub secret_key: String,
    pub environment: Environment,
    pub allowed_hosts: Vec<String>,
    pub log_level: String,
    pub bind_addr: String,
    pub time_zone: Option<String>,
    pub static_url: String,
    pub static_root: String,
    pub extra: HashMap<String, Value>,
}

Fields

database_url: String

databases: HashMap<String, String>

max_form_body_bytes: Option<usize>

Max request-body size (bytes) the Form<T> extractor buffers before returning 413 Payload Too Large. Default 16 MiB (8× the old hardcoded 2 MiB). Set UMBRAL_MAX_FORM_BODY_BYTES (or max_form_body_bytes in umbral.toml); set it to 0 to disable the cap entirely — handy in dev. (For large uploads use a file field / the storage backend, not the form extractor.)

db_max_connections: u32

Max connections in the Postgres pool (PERF-5). Default 10. Set via UMBRAL_DB_MAX_CONNECTIONS or db_max_connections in umbral.toml.

db_acquire_timeout_secs: u64

Seconds to wait for a free pooled connection before failing the request (Postgres acquire timeout, PERF-5). Default 30. Set via UMBRAL_DB_ACQUIRE_TIMEOUT_SECS or db_acquire_timeout_secs.

db_min_connections: u32

Idle-connection floor — the pool keeps at least this many warm connections (gaps2 #91). Default 0. Set via UMBRAL_DB_MIN_CONNECTIONS or db_min_connections.

db_idle_timeout_secs: Option<u64>

Close a connection after it’s been idle this many seconds (gaps2 #91). Default 600 (10 min). 0/empty disables idle reaping. Set via UMBRAL_DB_IDLE_TIMEOUT_SECS or db_idle_timeout_secs.

db_max_lifetime_secs: Option<u64>

Recycle a connection older than this many seconds (gaps2 #91). Default 1800 (30 min) — avoids stale connections behind a load balancer / Postgres idle-reaping. 0/empty disables. Set via UMBRAL_DB_MAX_LIFETIME_SECS or db_max_lifetime_secs.

db_test_before_acquire: bool

Health-check a pooled connection before handing it out (gaps2 #91). Default true. Set via UMBRAL_DB_TEST_BEFORE_ACQUIRE or db_test_before_acquire.

secret_key: String

environment: Environment

allowed_hosts: Vec<String>

log_level: String

bind_addr: String

The address the development server binds to. host:port format, e.g. 127.0.0.1:8000 (default), 0.0.0.0:80, [::1]:8000. Override with UMBRAL_BIND_ADDR or umbral.toml.

time_zone: Option<String>

Gap 106 — timezone for marshalling naive datetimes on the read and write boundary. None (default) keeps the historical UTC-everywhere behaviour: naive input is treated as UTC, admin-form display renders the stored UTC value verbatim.

Some("Africa/Nairobi") (any IANA tz name resolvable via chrono-tz) flips both ends: HTML <input type="datetime- local"> values arriving naive are interpreted in the configured tz then converted to UTC before storage; the admin form renders stored UTC values converted back to the configured tz so the user sees wall-clock time, not UTC. Column type stays TIMESTAMPTZ (Postgres) / TEXT (SQLite) — only the marshalling layer changes.

Set via UMBRAL_TIME_ZONE=Africa/Nairobi or time_zone = "Africa/Nairobi" in umbral.toml. An unknown tz name falls back to UTC at lookup time with a tracing warning rather than panicking — startup never fails on a tz config error.

static_url: String

URL prefix every collected/served static asset hangs under.

Default "/static/". The framework’s static handler mounts at this base and the static() template helper prepends it, so {{ static("admin/admin.css") }} resolves to "/static/admin/admin.css". Set a CDN origin (UMBRAL_STATIC_URL=https://cdn.example.com/s/) to serve assets off a separate host in production — the helper then emits absolute URLs and the local handler simply goes unused.

Always normalised to carry exactly one leading and one trailing slash: "/static", "static", and "/static/" all converge on "/static/". Set via UMBRAL_STATIC_URL or static_url in umbral.toml.

static_root: String

On-disk directory collected static assets live under in production.

Default "staticfiles/" (relative to the binary’s CWD). The static handler resolves a request /static/<ns>/<rest> to <static_root>/<ns>/<rest> in prod, and as the dev fallback when a plugin’s live source dir doesn’t have the file. Set via UMBRAL_STATIC_ROOT or static_root in umbral.toml.

extra: HashMap<String, Value>

Catch-all for UMBRAL_-prefixed environment variables (and umbral.toml keys) that don’t map to a named field above.

Real apps usually need keys the framework doesn’t know about — OPENAI_API_KEY, STRIPE_SECRET, third-party plugin configuration. Setting UMBRAL_OPENAI_API_KEY=sk-test makes settings.extra.get("openai_api_key") return a string value without the user crate having to wire a second figment loader.

Values are stored as toml::Value so a nested [external.openai] table in umbral.toml round-trips with its structure intact. The accessor Settings::extra_str handles the common scalar-string case.

Implementations

impl Settings

pub fn extra_str(&self, key: &str) -> Option<&str>

Read a scalar string from the extra map by key. Returns None if the key is absent or the value isn’t a string.

Most app-defined settings are scalar (UMBRAL_OPENAI_API_KEY= sk-test), so this helper is the right shape for the common case. For nested tables ([external.openai] in umbral.toml) the caller indexes into extra directly: settings.extra. get("external").and_then(|v| v.get("openai")).and_then(...).

pub fn from_env() -> Result<Self, Box<Error>>

Load settings from defaults, .env, umbral.toml, and UMBRAL_-prefixed env vars.

Precedence (later wins): struct defaults → umbral.toml → env vars. A local .env file is merged as an environment-shaped provider first, but existing process env vars keep precedence over values from .env. Implementation uses merge (not join) for both providers so each subsequent source overrides the previous one’s values. With join the first provider to set a key would keep it, which would invert the documented precedence.

The error type is boxed because figment::Error is large (over 200 bytes); see clippy::result_large_err.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Settings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Settings

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.