Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation on wrap_err vs wrap_err_with #93

Merged
merged 4 commits into from
Nov 24, 2023
Merged

Add documentation on wrap_err vs wrap_err_with #93

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a36ce88
Add documentation on wrap_err vs wrap_err_with
akshayknarayan Apr 20, 2023
a8a5776
Merge branch 'master' into wrap-err-docs
yaahc Sep 20, 2023
4919e04
make the text clearer
akshayknarayan Nov 21, 2023
a699d1b
Merge remote-tracking branch 'upstream/master' into wrap-err-docs
akshayknarayan Nov 24, 2023
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
7 changes: 7 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1096,6 +1096,13 @@ pub type Result<T, E = Report> = core::result::Result<T, E>;
/// # panic!("expected downcast to succeed");
/// }
/// ```
///
/// # `wrap_err` vs `wrap_err_with`
///
/// `wrap_err` incurs a runtime cost even in the non-error case because it requires eagerly
/// constructing the error object. `wrap_err_with` avoids this cost through lazy evaluation. This
/// cost is proportional to the cost of the currently installed [`EyreHandler`]'s creation step.
/// `wrap_err` is useful in cases where an constructed error object already exists.
pub trait WrapErr<T, E>: context::private::Sealed {
/// Wrap the error value with a new adhoc error
#[cfg_attr(track_caller, track_caller)]
Expand Down