Enum SettingsError 

#[non_exhaustive]
pub enum SettingsError {
    Parse {
        key: String,
        value_kind: &'static str,
    },
    OutOfRange {
        key: String,
        message: &'static str,
    },
}

Why a *Settings::from_env call failed. OutboxSettings::from_env (reliar-outbox) was the first caller; every provider’s own from_env returns this same type, so a host wiring several from_env calls handles one error type for the whole family.

use reliar_core::SettingsError;

let err = SettingsError::parse("RELIAR_OUTBOX_BATCH_SIZE", "u32");
assert_eq!(err.key(), "RELIAR_OUTBOX_BATCH_SIZE");
assert!(err.to_string().contains("could not be parsed"));

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Parse

A present variable could not be parsed as its declared type. The value is never echoed — it may carry an operator’s typo of something sensitive.

Fields

key: String

The full environment variable name, including the prefix.

value_kind: &'static str

The type or shape that was expected, e.g. "u32", "milliseconds".

OutOfRange

A present variable parsed but violated a documented bound.

Fields

key: String

The full environment variable name, including the prefix.

message: &'static str

The bound that was violated.

Implementations

impl SettingsError

Public constructors, because every provider’s from_env returns this type. SettingsError is #[non_exhaustive], so a crate other than the one defining a given Settings type — e.g. reliar-store-postgres — cannot build a variant with struct-literal syntax; without these a provider is forced into a parallel, unrelated error type, and a host wiring two from_env calls ends up handling two different errors for the same class of failure (ADR 0019).

pub fn parse(key: impl Into<String>, value_kind: &'static str) -> SettingsError

The variable was present but did not parse. value_kind names the expected shape ("u32", "milliseconds"); the offending value is never carried.

use reliar_core::SettingsError;

let err = SettingsError::parse("RELIAR_OUTBOX_BATCH_SIZE", "u32");
assert_eq!(err.key(), "RELIAR_OUTBOX_BATCH_SIZE");

pub fn out_of_range( key: impl Into<String>, message: &'static str, ) -> SettingsError

The variable parsed but is outside the range the setting accepts.

use reliar_core::SettingsError;

let err = SettingsError::out_of_range("RELIAR_OUTBOX_LEASE_SECS", "must be at least 1");
assert!(err.to_string().contains("out of range"));

pub fn key(&self) -> &str

The full environment-variable name, prefix included — what an operator has to go fix.

use reliar_core::SettingsError;

let err = SettingsError::out_of_range("RELIAR_OUTBOX_BATCH_SIZE", "must be at least 1");
assert_eq!(err.key(), "RELIAR_OUTBOX_BATCH_SIZE");

Trait Implementations

impl Clone for SettingsError

fn clone(&self) -> SettingsError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SettingsError

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

Formats the value using the given formatter.

impl Display for SettingsError

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

Formats the value using the given formatter.

impl Error for SettingsError

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 PartialEq for SettingsError

fn eq(&self, other: &SettingsError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SettingsError