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.

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
34 changes: 34 additions & 0 deletions tracing-core/src/field.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// A 'Value' which serializes error and it's sources.
/// A `Value` which serializes error and its sources.

Copy link
Contributor

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.

#[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>
Expand All @@ -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> {
Expand Down Expand Up @@ -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> {}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't it enought for T to outlive 'a?


#[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]
Expand Down