2 stable releases
1.1.0 | Apr 8, 2024 |
---|---|
1.0.0 | Apr 8, 2024 |
#1998 in Rust patterns
32 downloads per month
15KB
187 lines
multiple_errors
Propagate multiple errors instead of just the first one.
Description
Rust's ?
operator and Iterator::collect::<Result<_, _>>
return early on the
first encountered error. However,
sometimes
we want to execute multiple independent actions and then report all errors at
once. Or turn all results into errors if there is at least one error.
This crate covers these use cases and aims to become an easily googlable "hub" for:
- more "mass error handling" fuctionality
- knowledge about related functionality in other crates
Think of multiple_errors
as
itertools. It's also a
lightweight "pure logic" crate with no dependencies, and should be suitable for
no_std
and old MSRVs. I haven't worked on this yet, please open an issue or a
pull request if you need this.
Example
use multiple_errors::{fail_all_vec, return_multiple_errors, CollectVecResult};
use multiple_errors::testing_prelude::*;
assert_eq!(
[Err(ErrA), Ok(A), Err(ErrA)].into_iter().collect_vec_result(),
// Collected all errors, not just the first one
Err(vec![ErrA, ErrA])
);
let err = fail_all_vec(
vec![Ok(A), Err(ErrA), Ok(A)],
|res| res.err().map(HighLevelErr::from).unwrap_or(HighLevelErr::B(ErrB))
);
// Same length as the original, each element turned into an error.
assert_eq!(err, Err(vec![ErrB.into(), ErrA.into(), ErrB.into()]));
fn a_b_c() -> Result<(A, B, C), Vec<HighLevelErr>> {
return_multiple_errors!(
let mut errors: Vec<HighLevelErr> = vec![];
// Get some `Result`s:
let a = action_a();
let b = action_b();
let c = action_c();
if_there_are_errors {
// Already converted and collected
return Err(errors);
}
);
// Already unwrapped
Ok((a, b, c))
}
Similar crates
-
A Validated is either an Ok holding an HList or an Err, holding a vector of collected errors.
It achieves similar goals to
return_multiple_errors!
, but in a more abstract, type-heavy and composable way. -
itertools::Itertools::partition_result and more general partition_map
Partition a sequence of Results into one list of all the Ok elements and another list of all the Err elements.
If you need both lists, just use itertools. If you discard
Ok
s in case of errors, you can useCollectVecResult::collect_vec_result()
that returnsResult<Vec<T>, Vec<E>>
. It's more precise and efficient.
License
Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.