-
Notifications
You must be signed in to change notification settings - Fork 734
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.
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
core: add struct for recording errors #3113
Open
ziutech
wants to merge
1
commit into
tokio-rs:master
Choose a base branch
from
ziutech:error-value
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -44,6 +44,9 @@ use core::{ | |
ops::Range, | ||
}; | ||
|
||
#[cfg(feature = "std")] | ||
use std::error; | ||
|
||
use self::private::ValidLen; | ||
|
||
/// An opaque key allowing _O_(1) access to a field in a `Span`'s key-value | ||
|
@@ -270,6 +273,12 @@ pub struct DisplayValue<T: fmt::Display>(T); | |
#[derive(Clone)] | ||
pub struct DebugValue<T: fmt::Debug>(T); | ||
|
||
/// A 'Value' which serializes error and it's sources. | ||
#[cfg(feature = "std")] | ||
#[derive(Clone, Debug)] | ||
#[cfg_attr(docsrs, doc(cfg(feature = "std")))] | ||
pub struct ErrorValue<'a, T: error::Error + 'static>(&'a T); | ||
|
||
/// Wraps a type implementing `fmt::Display` as a `Value` that can be | ||
/// recorded using its `Display` implementation. | ||
pub fn display<T>(t: T) -> DisplayValue<T> | ||
|
@@ -288,6 +297,17 @@ where | |
DebugValue(t) | ||
} | ||
|
||
/// Wraps a reference to a type implementing `error::Error` as a `Value` | ||
/// that records the error's message and sources. | ||
#[cfg(feature = "std")] | ||
#[cfg_attr(docsrs, doc(cfg(feature = "std")))] | ||
pub fn error<'a, T>(t: &'a T) -> ErrorValue<'a, T> | ||
where | ||
T: error::Error + 'static, | ||
{ | ||
ErrorValue(t) | ||
} | ||
|
||
struct HexBytes<'a>(&'a [u8]); | ||
|
||
impl<'a> fmt::Debug for HexBytes<'a> { | ||
|
@@ -658,6 +678,20 @@ impl<T: fmt::Debug> fmt::Debug for DebugValue<T> { | |
} | ||
} | ||
|
||
// ===== impl ErrorValue ===== | ||
#[cfg(feature = "std")] | ||
impl<T: error::Error + 'static> crate::sealed::Sealed for ErrorValue<'_, T> {} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Isn't it enought for |
||
|
||
#[cfg(feature = "std")] | ||
impl<'a, T> Value for ErrorValue<'a, T> | ||
where | ||
T: error::Error + 'static, | ||
{ | ||
fn record(&self, key: &Field, visitor: &mut dyn Visit) { | ||
visitor.record_error(key, self.0) | ||
} | ||
} | ||
|
||
impl crate::sealed::Sealed for Empty {} | ||
impl Value for Empty { | ||
#[inline] | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also I'm not sure we should talk about sources here. What will be recorded is subscriber-specific, it can completely ignore the sources.