Struct ErrorList 

pub struct ErrorList { /* private fields */ }

Several failures reported as one error, such as every attempt of a race or every resolver of a fallback chain.

One of them is the primary failure: it is the Error::source, so error_chain and code that classifies an error by its chain keep working as for a single failure. By default the first pushed error is primary; ErrorList::push_primary picks another one.

CauseExt searches every failure in the list, not only the primary one.

{} renders the failures on one line, {:#} renders each with its own cause chain. Both escape control characters and write at most 64 errors, nested lists included.

use rama_error::{BoxError, BoxErrorExt, CauseExt, ErrorList};

let mut errors = ErrorList::new();
errors.push(BoxError::from_static_str("refused"));
errors.push(std::fmt::Error);

assert_eq!(errors.len(), 2);
assert_eq!(errors.to_string(), "2 errors: refused; an error occurred when formatting an argument");
assert!(errors.has_cause::<std::fmt::Error>());

Implementations

impl ErrorList

pub const fn new() -> ErrorList

An empty list.

pub fn with_capacity(capacity: usize) -> ErrorList

An empty list with room for capacity failures.

pub fn push(&mut self, error: impl Into<Box<dyn Error + Send + Sync>>)

Add a failure.

pub fn push_primary(&mut self, error: impl Into<Box<dyn Error + Send + Sync>>)

Add a failure and make it the primary one.

pub fn len(&self) -> usize

The number of failures.

pub fn is_empty(&self) -> bool

Whether no failure was added.

pub fn primary(&self) -> Option<&(dyn Error + Send + Sync + 'static)>

The primary failure, if any.

pub fn iter(&self) -> impl ExactSizeIterator

Every failure, in the order they were added.

pub fn into_vec(self) -> Vec<Box<dyn Error + Send + Sync>>

Every failure, in the order they were added.

pub fn into_error(self) -> Option<Box<dyn Error + Send + Sync>>

Turn this list into a single error: the only failure when there is one, otherwise the list itself. None when the list is empty.

Trait Implementations

impl Debug for ErrorList

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

Formats the value using the given formatter.

impl Default for ErrorList

fn default() -> ErrorList

Returns the “default value” for a type.

impl Display for ErrorList

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

Formats the value using the given formatter.

impl Error for ErrorList

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<E> Extend<E> for ErrorList

where E: Into<Box<dyn Error + Send + Sync>>,

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = E>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: T)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<E> FromIterator<E> for ErrorList

where E: Into<Box<dyn Error + Send + Sync>>,

fn from_iter<I>(iter: I) -> ErrorList

where I: IntoIterator<Item = E>,

Creates a value from an iterator.