Skip to main content

Error

Enum Error 

Source
pub enum Error {
    Missing {
        name: String,
    },
    Invalid {
        name: String,
        expected: String,
        got: String,
    },
    Conflict {
        message: String,
    },
}
Expand description

One thing wrong with one variable.

Each variant names the variable, because the first thing anyone does with a configuration error is search the deployment for that name.

Variants§

§

Missing

A required variable is unset or blank.

Fields

§name: String

The variable’s name.

§

Invalid

A variable is set to something that is not the shape it must be.

Fields

§name: String

The variable’s name.

§expected: String

What was expected, as a noun phrase: a positive integer.

§got: String

What was there.

Quoted in the message. Configuration values are operational rather than sensitive — and the one kind that is not should be read through crate::Secret, which never reaches this type.

§

Conflict

Two or more variables are individually fine but cannot be combined.

Fields

§message: String

The whole sentence, because a conflict is about a relationship and there is no single name to lead with.

Implementations§

Source§

impl Error

Source

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

A required variable is unset or blank.

§Examples
use env_reader::Error;

let error = Error::missing("DATABASE_URL");
assert_eq!(error.to_string(), "missing required configuration: DATABASE_URL");
Source

pub fn invalid( name: impl Into<String>, expected: impl Into<String>, got: impl Into<String>, ) -> Self

A variable holds something of the wrong shape.

§Examples
use env_reader::Error;

let error = Error::invalid("PORT", "a whole number", "two");
assert_eq!(
    error.to_string(),
    r#"invalid configuration: PORT must be a whole number, got "two""#
);
Source

pub fn conflict(message: impl Into<String>) -> Self

Variables that cannot be combined as configured.

§Examples
use env_reader::Error;

let error = Error::conflict("Cannot specify both QUEUE_NAME and TOPIC_NAME.");
assert!(error.to_string().starts_with("Cannot specify both"));
Source

pub fn name(&self) -> Option<&str>

The variable this is about, when it is about one.

Error::Conflict concerns a relationship between variables and so names none.

§Examples
use env_reader::Error;

assert_eq!(Error::missing("PORT").name(), Some("PORT"));
assert_eq!(Error::conflict("either, not both").name(), None);

Trait Implementations§

Source§

impl Clone for Error

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Error

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Error

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Error

Source§

impl Error for Error

1.30.0 · Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl PartialEq for Error

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Error

Auto Trait Implementations§

§

impl Freeze for Error

§

impl RefUnwindSafe for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnsafeUnpin for Error

§

impl UnwindSafe for Error

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.