GEN-196: Move error-stack-experimental into error-stack

Cargo.toml

@@ -29,7 +29,6 @@ members = [
     "libs/deer/macros",
     "libs/error-stack",
     "libs/error-stack/macros",
-    "libs/error-stack/experimental",
     "libs/sarif",
 ]
 default-members = [

libs/error-stack/CHANGELOG.md

@@ -11,11 +11,13 @@ All notable changes to `error-stack` will be documented in this file.
 ### Features
 
 - Report has been split into `Report<C>` and `Report<[C]>` to distinguish between a group of related errors and a single error. These errors can still be nested.
+- Introduce a new `unstable` flag, which is used to enable unstable features, these features are not covered by semver and may be modified or removed at any time.
 
 ### Breaking Changes
 
 - `Extend` is no longer implemented by `Report<C>`, instead it is implemented on `Report<[C]>`, either use `From` or `Report::expand` to convert between `Report<C>` into `Report<[C]>`.
 - `extend_one` has been renamed to `push` and is only implemented on `Report<[C]>`.
+- `bail!(report,)` has been removed, one must now use `bail!(report)`. This is in preparation for the unstable `bail!` macro that allows to construct `Report<[C]>`.
 
 ## [0.5.0](https://github.com/hashintel/hash/tree/error-stack%400.5.0/libs/error-stack) - 2024-07-12
 

libs/error-stack/Cargo.toml

@@ -20,8 +20,10 @@ exclude = ["package.json", "macros", "experimental"]
 anyhow = { version = ">=1.0.73", public = true, default-features = false, optional = true }
 eyre = { version = ">=0.6", public = true, default-features = false, optional = true }
 serde = { version = ">=1", default-features = false, public = true, optional = true }
+futures-core = { workspace = true, public = true, optional = true }
 
 # Private workspace dependencies
+pin-project-lite = { workspace = true, optional = true }
 
 # Private third-party dependencies
 spin = { version = ">=0.9", default-features = false, optional = true, features = ['rwlock', 'once'] }
@@ -42,6 +44,7 @@ supports-color = { workspace = true }
 supports-unicode = { workspace = true }
 owo-colors = { workspace = true }
 thiserror = { workspace = true }
+futures-util.workspace = true
 
 [build-dependencies]
 rustc_version = { workspace = true }
@@ -59,6 +62,10 @@ hooks = ['dep:spin']  # Enables hooks on `no-std` platforms using spin locks
 anyhow = ["dep:anyhow"]  # Provides `into_report` to convert `anyhow::Error` to `Report`
 eyre = ["dep:eyre", "std"]  # Provides `into_report` to convert `eyre::Report` to `Report`
 
+futures = ["dep:futures-core", "dep:pin-project-lite"] # Provides support for `futures` types, such as stream.
+
+unstable = [] # Enables unstable features that are not covered under any stability guarantees
+
 [lints]
 workspace = true
 

libs/error-stack/experimental/src/iter.rs → libs/error-stack/src/ext/iter.rs

@@ -1,4 +1,4 @@
-use error_stack::{Context, Report, Result};
+use crate::{Context, Report, Result};
 
 // inspired by the implementation in `std`, see: https://doc.rust-lang.org/1.81.0/src/core/iter/adapters/mod.rs.html#157
 // except with the removal of the Try trait, as it is unstable.
@@ -81,10 +81,22 @@ where
     report.map_or_else(|| Ok(value), |report| Err(report))
 }
 
-/// An extension trait for iterators that allows collecting items while handling errors.
+/// An extension trait for iterators that enables error-aware collection of items.
 ///
-/// This trait provides additional functionality to iterators that yield `Result` items,
-/// allowing them to be collected into a container while propagating any errors encountered.
+/// This trait enhances iterators yielding `Result` items by providing methods to
+/// collect successful items into a container while aggregating encountered errors.
+///
+/// # Performance Considerations
+///
+/// These methods may have performance implications as they potentially iterate
+/// through the entire collection, even after encountering errors.
+///
+/// # Unstable Feature
+///
+/// This trait is currently available only under the `unstable` feature flag and
+/// does not adhere to semver guarantees. Its API may change in future releases.
+///
+/// [`Report`]: crate::Report
 pub trait TryReportIteratorExt<C> {
     /// The type of the successful items in the iterator.
     type Ok;
@@ -104,9 +116,8 @@ pub trait TryReportIteratorExt<C> {
     /// # Examples
     ///
     /// ```
-    /// use error_stack::{Result, ResultExt, Report};
+    /// use error_stack::{Result, Report, TryReportIteratorExt};
     /// use std::io;
-    /// use error_stack_experimental::TryReportIteratorExt;
     ///
     /// fn fetch_fail() -> Result<u8, io::Error> {
     ///    # stringify! {
@@ -140,9 +151,8 @@ pub trait TryReportIteratorExt<C> {
     /// # Examples
     ///
     /// ```
-    /// use error_stack::{Result, ResultExt, Report};
+    /// use error_stack::{Result, Report, TryReportIteratorExt};
     /// use std::io;
-    /// use error_stack_experimental::TryReportIteratorExt;
     ///
     /// fn fetch_fail() -> Result<u8, io::Error> {
     ///    # stringify! {
@@ -187,8 +197,8 @@ where
 #[cfg(test)]
 mod tests {
     #![allow(clippy::integer_division_remainder_used)]
+    use alloc::{collections::BTreeSet, vec::Vec};
     use core::fmt;
-    use std::collections::HashSet;
 
     use super::*;
 
@@ -216,7 +226,7 @@ mod tests {
         let result: Result<Vec<_>, [CustomError]> = iter.try_collect_reports();
         let report = result.expect_err("should have failed");
 
-        let contexts: HashSet<_> = report.current_contexts().collect();
+        let contexts: BTreeSet<_> = report.current_contexts().collect();
         assert_eq!(contexts.len(), 2);
         assert!(contexts.contains(&CustomError(1)));
         assert!(contexts.contains(&CustomError(3)));
@@ -235,7 +245,7 @@ mod tests {
         let result: Result<Vec<_>, [CustomError]> = iter.try_collect_reports_bounded(3);
         let report = result.expect_err("should have failed");
 
-        let contexts: HashSet<_> = report.current_contexts().collect();
+        let contexts: BTreeSet<_> = report.current_contexts().collect();
         assert_eq!(contexts.len(), 3);
         assert!(contexts.contains(&CustomError(1)));
         assert!(contexts.contains(&CustomError(3)));
@@ -265,7 +275,7 @@ mod tests {
         let result: Result<Vec<_>, [CustomError]> = iter.try_collect_reports();
         let report = result.expect_err("should have failed");
 
-        let contexts: HashSet<_> = report.current_contexts().collect();
+        let contexts: BTreeSet<_> = report.current_contexts().collect();
         assert_eq!(contexts.len(), 2);
         assert!(contexts.contains(&CustomError(1)));
         assert!(contexts.contains(&CustomError(3)));

libs/error-stack/src/ext/mod.rs

@@ -0,0 +1,19 @@
+//! Extension traits for `Report` and `Result`.
+//!
+//! These traits are currently unstable and require the `unstable` feature flag to be enabled.
+//! They provide additional functionality and convenience methods for error handling and
+//! manipulation.
+//!
+//! # Note
+//!
+//! The traits and methods in this module are subject to change and may be modified or
+//! removed in future versions. Use them with caution in production environments.
+
+pub(crate) mod iter;
+#[cfg(feature = "futures")]
+pub(crate) mod stream;
+pub(crate) mod tuple;
+
+#[cfg(feature = "futures")]
+pub use self::stream::{TryCollectReports, TryReportStreamExt};
+pub use self::{iter::TryReportIteratorExt, tuple::TryReportTupleExt};