GEN-38: Minor improvements of code quality (#2885)

Author: TimDiekmann

libs/error-stack/src/compat.rs

@@ -1,8 +1,6 @@
 //! Compatibility module to convert errors from other libraries into [`Report`].
 //!
 //! In order to convert these error types, use [`IntoReportCompat::into_report()`].
-//!
-//! [`Report`]: crate::Report
 
 use crate::Report;
 
@@ -19,7 +17,6 @@ mod eyre;
 /// would imply an implementation for [`Context`]. This also implies, that it's not possible to
 /// implement [`ResultExt`] from within `error-stack`.
 ///
-/// [`Report`]: Report
 /// [`ResultExt`]: crate::ResultExt
 /// [`Context`]: crate::Context
 /// [`Error`]: core::error::Error

libs/error-stack/src/context.rs

@@ -1,8 +1,6 @@
-#[cfg(nightly)]
-use core::any::Demand;
-#[cfg(nightly)]
-use core::error::Error;
 use core::fmt;
+#[cfg(nightly)]
+use core::{any::Demand, error::Error};
 #[cfg(all(not(nightly), feature = "std"))]
 use std::error::Error;
 
@@ -13,14 +11,11 @@ use crate::Report;
 /// When in a `std` environment or on a nightly toolchain, every [`Error`] is a valid `Context`.
 /// This trait is not limited to [`Error`]s and can also be manually implemented on a type.
 ///
-/// [`Error`]: core::error::Error
-///
 /// ## Example
 ///
 /// Used for creating a [`Report`] or for switching the [`Report`]'s context:
 ///
 /// ```rust
-/// # #![cfg_attr(any(not(feature = "std"), miri), allow(unused_imports))]
 /// use std::{fmt, fs, io};
 ///
 /// use error_stack::{Context, Result, ResultExt, Report};
@@ -32,7 +27,7 @@ use crate::Report;
 /// }
 ///
 /// impl fmt::Display for ConfigError {
-///     # #[allow(unused_variables)]
+///     # #[allow(unused_variables)] // `fmt` is not used in this example
 ///     fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
 ///         # const _: &str = stringify! {
 ///         ...
@@ -44,9 +39,6 @@ use crate::Report;
 /// // `Context` manually.
 /// impl Context for ConfigError {}
 ///
-/// # #[cfg(any(not(feature = "std"), miri))]
-/// # pub fn read_file(_: &str) -> Result<String, ConfigError> { error_stack::bail!(ConfigError::ParseError) }
-/// # #[cfg(all(feature = "std", not(miri)))]
 /// pub fn read_file(path: &str) -> Result<String, io::Error> {
 ///     // Creates a `Report` from `io::Error`, the current context is `io::Error`
 ///     fs::read_to_string(path).map_err(Report::from)
@@ -62,7 +54,6 @@ use crate::Report;
 ///     # }; Ok(())
 /// }
 /// # let err = parse_config("invalid-path").unwrap_err();
-/// # #[cfg(all(feature = "std", not(miri)))]
 /// # assert!(err.contains::<io::Error>());
 /// # assert!(err.contains::<ConfigError>());
 /// ```

libs/error-stack/src/fmt.rs

@@ -320,7 +320,7 @@ pub use hook::HookContext;
 #[cfg(any(feature = "std", feature = "hooks"))]
 pub(crate) use hook::{install_builtin_hooks, Format, Hooks};
 #[cfg(not(any(feature = "std", feature = "hooks")))]
-use location::LocationDisplay;
+use location::LocationAttachment;
 
 use crate::{
     fmt::{
@@ -864,7 +864,7 @@ fn debug_attachments_invoke<'a>(
             FrameKind::Attachment(AttachmentKind::Opaque(_)) => frame
                 .downcast_ref::<core::panic::Location<'static>>()
                 .map(|location| {
-                    vec![LocationDisplay::new(location, config.color_mode()).to_string()]
+                    vec![LocationAttachment::new(location, config.color_mode()).to_string()]
                 }),
         })
         .flat_map(|body| {

libs/error-stack/src/fmt/charset.rs

@@ -58,7 +58,7 @@ impl Report<()> {
     ///
     /// # Example
     ///
-    /// ```
+    /// ```rust
     /// # // we only test the snapshot on nightly, therefore report is unused (so is render)
     /// # #![cfg_attr(not(nightly), allow(dead_code, unused_variables, unused_imports))]
     /// use std::io::{Error, ErrorKind};

libs/error-stack/src/fmt/color.rs

@@ -67,7 +67,7 @@ impl Report<()> {
     ///
     /// # Example
     ///
-    /// ```
+    /// ```rust
     /// # // we only test the snapshot on nightly, therefore report is unused (so is render)
     /// # #![cfg_attr(not(nightly), allow(dead_code, unused_variables, unused_imports))]
     /// use std::io::{Error, ErrorKind};

libs/error-stack/src/fmt/config.rs

@@ -43,9 +43,7 @@ pub(crate) struct Config {
 
 #[cfg(not(any(feature = "std", feature = "hooks")))]
 impl Config {
-    // alternate is still provided, as it is used in the hook counterpart
-    #[allow(unused)]
-    pub(crate) const fn new(color_mode: ColorMode, charset: Charset, alternate: bool) -> Self {
+    pub(crate) const fn new(color_mode: ColorMode, charset: Charset, _alternate: bool) -> Self {
         Self {
             color_mode,
             charset,

libs/error-stack/src/fmt/hook.rs

@@ -468,7 +468,7 @@ mod default {
     use tracing_error::SpanTrace;
 
     use crate::{
-        fmt::{hook::HookContext, location::LocationDisplay},
+        fmt::{hook::HookContext, location::LocationAttachment},
         Report,
     };
 
@@ -507,7 +507,7 @@ mod default {
     }
 
     fn location(location: &Location<'static>, context: &mut HookContext<Location<'static>>) {
-        context.push_body(LocationDisplay::new(location, context.color_mode()).to_string());
+        context.push_body(LocationAttachment::new(location, context.color_mode()).to_string());
     }
 
     #[cfg(all(feature = "std", rust_1_65))]

libs/error-stack/src/fmt/location.rs

@@ -1,28 +1,21 @@
-use core::{
-    fmt,
-    fmt::{Display, Formatter},
-    panic::Location,
-};
-
-use crate::fmt::{
-    color::{Color, DisplayStyle, Style},
-    ColorMode,
-};
-
-pub(super) struct LocationDisplay<'a> {
-    location: &'a Location<'static>,
+use core::{fmt, panic::Location};
+
+use crate::fmt::color::{Color, ColorMode, DisplayStyle, Style};
+
+pub(super) struct LocationAttachment<'a, 'loc> {
+    location: &'a Location<'loc>,
     mode: ColorMode,
 }
 
-impl<'a> LocationDisplay<'a> {
+impl<'a, 'loc> LocationAttachment<'a, 'loc> {
     #[must_use]
-    pub(super) const fn new(location: &'a Location<'static>, mode: ColorMode) -> Self {
+    pub(super) const fn new(location: &'a Location<'loc>, mode: ColorMode) -> Self {
         Self { location, mode }
     }
 }
 
-impl<'a> Display for LocationDisplay<'a> {
-    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
+impl fmt::Display for LocationAttachment<'_, '_> {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         let location = self.location;
 
         let mut style = Style::new();

libs/error-stack/src/frame/frame_impl.rs

@@ -18,7 +18,6 @@ pub(super) trait FrameImpl: Send + Sync + 'static {
     fn provide<'a>(&'a self, demand: &mut Demand<'a>);
 }
 
-#[repr(C)]
 struct ContextFrame<C> {
     context: C,
 }
@@ -42,7 +41,6 @@ impl<C: Context> FrameImpl for ContextFrame<C> {
     }
 }
 
-#[repr(C)]
 struct AttachmentFrame<A> {
     attachment: A,
 }
@@ -66,7 +64,6 @@ impl<A: 'static + Send + Sync> FrameImpl for AttachmentFrame<A> {
     }
 }
 
-#[repr(C)]
 struct PrintableAttachmentFrame<A> {
     attachment: A,
 }
@@ -210,6 +207,20 @@ impl Frame {
         }
     }
 
+    /// Creates a frame from an attachment which implements [`Debug`] and [`Display`].
+    ///
+    /// [`Debug`]: core::fmt::Debug
+    /// [`Display`]: core::fmt::Display
+    pub(crate) fn from_printable_attachment<A>(attachment: A, sources: Box<[Self]>) -> Self
+    where
+        A: fmt::Display + fmt::Debug + Send + Sync + 'static,
+    {
+        Self {
+            frame: Box::new(PrintableAttachmentFrame { attachment }),
+            sources,
+        }
+    }
+
     /// Creates a frame from an [`anyhow::Error`].
     #[cfg(feature = "anyhow")]
     pub(crate) fn from_anyhow(error: anyhow::Error, sources: Box<[Self]>) -> Self {
@@ -227,18 +238,4 @@ impl Frame {
             sources,
         }
     }
-
-    /// Creates a frame from an attachment which implements [`Debug`] and [`Display`].
-    ///
-    /// [`Debug`]: core::fmt::Debug
-    /// [`Display`]: core::fmt::Display
-    pub(crate) fn from_printable_attachment<A>(attachment: A, sources: Box<[Self]>) -> Self
-    where
-        A: fmt::Display + fmt::Debug + Send + Sync + 'static,
-    {
-        Self {
-            frame: Box::new(PrintableAttachmentFrame { attachment }),
-            sources,
-        }
-    }
 }

libs/error-stack/src/hook.rs

@@ -27,7 +27,7 @@ impl Report<()> {
     ///
     /// # Examples
     ///
-    /// ```
+    /// ```rust
     /// # // we only test the snapshot on nightly, therefore report is unused (so is render)
     /// # #![cfg_attr(not(nightly), allow(dead_code, unused_variables, unused_imports))]
     /// use std::io::{Error, ErrorKind};
@@ -71,7 +71,7 @@ impl Report<()> {
     /// This example showcases the ability of hooks to be invoked for values provided via the
     /// Provider API using [`Error::provide`].
     ///
-    /// ```
+    /// ```rust
     /// # // this is a lot of boilerplate, if you find a better way, please change this!
     /// # // with #![cfg(nightly)] docsrs will complain that there's no main in non-nightly
     /// # #![cfg_attr(nightly, feature(error_generic_member_access, provide_any))]