Enum BindError 

#[non_exhaustive]
pub enum BindError {
    MissingVariable {
        name: VariableName,
    },
    EmptyVariable {
        name: VariableName,
    },
    Environment {
        name: VariableName,
        source: EnvironmentError,
    },
    InvalidBoolean {
        name: VariableName,
    },
    ParseVariable {
        name: VariableName,
        expected: &'static str,
    },
    Validation {
        name: VariableName,
        message: String,
    },
    ValueTooLarge {
        name: VariableName,
        max_bytes: usize,
    },
}

Binding failure for one environment variable.

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.

MissingVariable

Required variable missing.

Fields

name: VariableName

Environment variable name.

EmptyVariable

Required variable empty.

Fields

name: VariableName

Environment variable name.

Environment

Environment adapter failed during variable read.

Fields

name: VariableName

Environment variable name.

source: EnvironmentError

Adapter failure.

InvalidBoolean

Boolean value invalid.

Fields

name: VariableName

Environment variable name.

ParseVariable

Parsed value invalid for the expected type.

Fields

name: VariableName

Environment variable name.

expected: &'static str

Expected type text.

Validation

Value failed validation.

Fields

name: VariableName

Environment variable name.

message: String

Safe validation detail.

ValueTooLarge

Raw value exceeded the configured byte limit.

Fields

name: VariableName

Environment variable name.

max_bytes: usize

Maximum accepted byte count.

Implementations

impl BindError

pub fn missing(name: impl Into<VariableName>) -> Self

Build a missing-variable error.

pub fn empty(name: impl Into<VariableName>) -> Self

Build an empty-variable error.

pub fn environment( name: impl Into<VariableName>, source: EnvironmentError, ) -> Self

Build an environment adapter error.

pub fn invalid_boolean(name: impl Into<VariableName>) -> Self

Build a boolean parse error.

pub fn parse(name: impl Into<VariableName>, expected: &'static str) -> Self

Build a typed parse error.

pub fn validation(name: impl Into<VariableName>, error: ValidationError) -> Self

Build a validation error.

pub fn validation_with_sensitivity( name: impl Into<VariableName>, error: ValidationError, sensitive: bool, ) -> Self

Build a validation error, hiding custom details for sensitive values.

pub fn value_too_large(name: impl Into<VariableName>, max_bytes: usize) -> Self

Build a value-size limit error.

pub fn variable_name(&self) -> &str

Return the environment variable name associated with the error.

pub fn error_code(&self) -> &'static str

Return a stable error code.

Trait Implementations

impl Clone for BindError

fn clone(&self) -> BindError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BindError

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

Formats the value using the given formatter.

impl Display for BindError

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

Formats the value using the given formatter.

impl Error for BindError

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 BindError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for BindError

impl StructuralPartialEq for BindError