Enum ConfigError 

pub enum ConfigError {
    File {
        path: String,
        source: Box<Self>,
    },
    Ron(SpannedError),
    Json(Error),
    Routing(ConfigError),
    Io(Error),
    Env {
        var: String,
        reason: String,
    },
    InvalidDbName {
        name: String,
        reason: &'static str,
        cure: &'static str,
    },
    InvalidBlobBackendProject {
        name: String,
        reason: &'static str,
        cure: &'static str,
    },
    InvalidListener {
        name: String,
        reason: &'static str,
        cure: &'static str,
    },
    Resolve(String),
}

A failure loading or parsing a local config file (project.cfg / boatramp.cfg).

Variants

File

Wraps an underlying error with the file path it came from.

Fields

path: String

source: Box<Self>

Ron(SpannedError)

The RON document failed to parse.

Json(Error)

The JSON document failed to parse (JSON config input — e.g. from nickel export). Same strictness as RON: deny_unknown_fields on the structs makes a typo’d/unknown key a hard error here, not a silent drop.

Routing(ConfigError)

The routing section failed its compile-check.

Io(Error)

Reading the file failed (other than not-found, which yields defaults).

Env

An environment-variable override could not be parsed (bad number/bool).

Fields

var: String

The offending BOATRAMP_* variable. Owned because some names are built dynamically (the keyed databases map, whose members aren’t known at compile time).

reason: String

Why the value was rejected.

InvalidDbName

A handlers.bindings.sql.databases binding name is not a safe URL path segment — it is threaded verbatim into /api/sql/{db}/… and --db, so an empty///-collapsing or path-separator-bearing name is refused at load (fail-closed) rather than emitting a malformed control-plane path.

Fields

name: String

The offending binding name (the databases map key).

reason: &'static str

Why it was rejected (from the canonical validator).

cure: &'static str

A trailing remediation hint (empty unless this is the legacy empty-name default case, where it points at the default cure).

InvalidBlobBackendProject

A [serve.blob_backends.<project>] key is not a valid project name, or is the reserved default project (which always resolves the global [serve] backend). Refused at config load (fail-closed) rather than silently binding a project’s blobs to the wrong backend.

Fields

name: String

The offending project key (the blob_backends map key).

reason: &'static str

Why it was rejected.

cure: &'static str

A trailing remediation hint.

InvalidListener

A [serve.listeners.<name>] (host-owned inbound-TCP listener, PLAN-handler-tcp-inbound) is invalid: a blank component, a non-positive max_conns/timeout, a declared-but-unsupported tls block (Phase 1 is plaintext-only), or a non-empty egress_allowlist (a tcp-connection-host guest imports only wasi:io — it cannot hold wasi:sockets). Refused at config load (fail-closed, boot-LOUD) rather than binding a listener that would silently mislead the operator.

Fields

name: String

The offending listener key (the listeners map key).

reason: &'static str

Why it was rejected.

cure: &'static str

A trailing remediation hint (empty unless there is a concrete cure to point at).

Resolve(String)

The layered config pipeline failed to resolve/extract the merged config (a bad numeric/addr env value that figment’s lossy coercion rejects, a [cluster] missing its required listen, etc.). The figment error is rendered to a string so ConfigError stays small.

Trait Implementations

impl Debug for ConfigError

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

Formats the value using the given formatter.

impl Display for ConfigError

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

Formats the value using the given formatter.

impl Error for ConfigError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<ConfigError> for ConfigError

fn from(source: ConfigError) -> Self

Converts to this type from the input type.

impl From<Error> for ConfigError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ConfigError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<SpannedError> for ConfigError

fn from(source: SpannedError) -> Self

Converts to this type from the input type.