Skip to main content

Errors

Struct Errors 

Source
pub struct Errors(/* private fields */);
Expand description

Every problem found while reading a configuration.

Constructed by crate::Reader::finish. It is never empty: a reader with no problems returns Ok instead.

It renders one problem per line, so a process’s last words are the whole list rather than the first item of it.

§Examples

use env_reader::Reader;

let mut reader = Reader::from_pairs([("PORT", "two")]);
let _: String = reader.required_string("SERVICE_NAME");
let _: u16 = reader.integer_or("PORT", 8080);

let errors = reader.finish().unwrap_err();
assert_eq!(errors.len(), 2);
assert_eq!(
    errors.to_string(),
    "missing required configuration: SERVICE_NAME\n\
     invalid configuration: PORT must be a whole number, got \"two\""
);

Implementations§

Source§

impl Errors

Source

pub fn new(errors: Vec<Error>) -> Self

Wrap a non-empty list of problems.

§Panics

Panics if errors is empty. An empty error is not a thing this type can represent, and a caller that has none should be returning Ok.

Source

pub fn len(&self) -> usize

How many problems there are.

§Examples
use env_reader::{Error, Errors};

let errors = Errors::new(vec![Error::missing("PORT")]);
assert_eq!(errors.len(), 1);
assert!(!errors.is_empty());
Source

pub fn is_empty(&self) -> bool

Always false; see Errors::new.

Present because clippy asks for it beside Errors::len, and because a caller writing if errors.is_empty() deserves an answer rather than a compile error.

Source

pub fn iter(&self) -> Iter<'_, Error> ⓘ

The problems, in the order they were found.

§Examples
use env_reader::{Error, Errors};

let errors = Errors::new(vec![Error::missing("A"), Error::missing("B")]);
let names: Vec<_> = errors.iter().filter_map(Error::name).collect();
assert_eq!(names, ["A", "B"]);
Source

pub fn into_inner(self) -> Vec<Error>

The problems, consuming this.

Trait Implementations§

Source§

impl Clone for Errors

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 Errors

Source§

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

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

impl Display for Errors

Source§

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

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

impl Eq for Errors

Source§

impl Error for Errors

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<'a> IntoIterator for &'a Errors

Source§

type Item = &'a Error

The type of the elements being iterated over.
Source§

type IntoIter = Iter<'a, Error>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl IntoIterator for Errors

Source§

type Item = Error

The type of the elements being iterated over.
Source§

type IntoIter = IntoIter<Error>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl PartialEq for Errors

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 Errors

Auto Trait Implementations§

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.