Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
/target
/.direnv
/.claude
6 changes: 6 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,14 @@
//! - **[`rootcause-backtrace`]** - Automatic stack trace capture for debugging.
//! Install hooks to attach backtraces to all errors, or use the extension
//! trait to add them selectively.
//! - **[`rootcause-tracing`]** - Integration with the [`tracing`] crate, annotating
//! reports with what span they were created in.
//! - More to come, including OpenTelemetry integration, and
//! a crate of fun extra bits and pieces.
//!
//! [`rootcause-backtrace`]: https://docs.rs/rootcause-backtrace
//! [`tracing`]: https://docs.rs/tracing
//! [`rootcause-tracing`]: https://docs.rs/rootcause-tracing
//!
//! ## Project Goals
//!
Expand Down
2 changes: 2 additions & 0 deletions src/prelude.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@
//! - **[`handlers`]**: Built-in error handlers for common scenarios
//! - **[`markers`]**: Type markers for controlling report behavior
//! - **[`report_attachment!`]**: Macro for attaching contextual data
//! - **[`IntoRootcause`]**: Conversion trait for converting other kinds of
//! errors into [`Report`]s
//!
//! # When to Use the Prelude
//!
Expand Down
9 changes: 9 additions & 0 deletions src/result_ext.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@ use crate::{
/// - **Adding attachments**: [`attach`](ResultExt::attach),
/// [`attach_with`](ResultExt::attach_with), and variants add supplementary
/// data to the error
/// - **Conversions:**
/// - [`context_to`](ResultExt::context_to) allows transformation of
/// contexts using the [`ReportConversion`] trait.
/// - [`context_transform`](ResultExt::context_transform) uses a closure
/// to transform contexts.
/// - [`context_transform_nested`](ResultExt::context_transform_nested)
/// removes the context, leaving a [`PreformattedContext`] in its place
/// and then transforms the removed context before creating a new report
/// with that context, wrapping the old one.
///
/// Each method has a `local_*` variant for working with types that are not
/// `Send + Sync`.
Expand Down
Loading