style: Rearrange the code slightly

notheotherben · notheotherben · commit dc77ae498405 · 2025-12-23T10:31:04.000Z
diff --git a/src/error.rs b/src/error.rs
@@ -1,45 +1,5 @@
 use std::{error, fmt};
-
-/// The kind of error which occurred.
-///
-/// Distinguishes between errors which were the result of user actions
-/// and those which were the result of system failures. Conceptually
-/// similar to HTTP status codes in that 4xx errors are user-caused
-/// and 5xx errors are system-caused.
-#[derive(Debug, PartialEq, Eq)]
-pub enum Kind {
-    /// An error which was the result of actions that the user took.
-    ///
-    /// These errors are usually things which a user can easily resolve by
-    /// changing how they interact with the system. Advice should be used
-    /// to guide the user to the correct interaction paths and help them
-    /// self-mitigate without needing to open support tickets.
-    ///
-    /// These errors are usually generated with [`crate::user`], [`crate::user_with_cause`]
-    /// and [`crate::user_with_internal`].
-    User,
-
-    /// An error which was the result of the system failing rather than the user's actions.
-    ///
-    /// These kinds of issues are usually the result of the system entering
-    /// an unexpected state and/or violating an assumption on behalf of the
-    /// developer. Often these issues cannot be resolved by the user directly,
-    /// so the advice should guide them to the best way to raise a bug with you
-    /// and provide you with information to help them fix the issue.
-    ///
-    /// These errors are usually generated with [`crate::system`], [`crate::system_with_cause`]
-    /// and [`crate::system_with_internal`].
-    System,
-}
-
-impl Kind {
-    fn format_description(&self, description: &str) -> String {
-        match self {
-            Kind::User => format!("Oh no! {description}"),
-            Kind::System => format!("Whoops! {description} (This isn't your fault)"),
-        }
-    }
-}
+use super::Kind;
 
 /// The fundamental error type used by this library.
 ///
@@ -92,6 +52,27 @@ impl Error {
         }
     }
 
+    /// Checks if this error is of a specific kind.
+    ///
+    /// Returns `true` if this error matches the provided [Kind],
+    /// otherwise `false`.
+    ///
+    /// # Examples
+    /// ```
+    /// use human_errors;
+    ///
+    /// let err = human_errors::user(
+    ///   "We could not open the config file you provided.",
+    ///   &["Make sure that the file exists and is readable by the application."],
+    /// );
+    ///
+    /// // Prints "is_user?: true"
+    /// println!("is_user?: {}", err.is(human_errors::Kind::User));
+    /// ```
+    pub fn is(&self, kind: Kind) -> bool {
+        self.kind == kind
+    }
+
     /// Gets the description message from this error.
     ///
     /// Gets the description which was provided as the first argument when constructing
@@ -212,27 +193,6 @@ impl Error {
 
         advice
     }
-
-    /// Checks if this error is of a specific kind.
-    ///
-    /// Returns `true` if this error matches the provided [Kind],
-    /// otherwise `false`.
-    ///
-    /// # Examples
-    /// ```
-    /// use human_errors;
-    ///
-    /// let err = human_errors::user(
-    ///   "We could not open the config file you provided.",
-    ///   &["Make sure that the file exists and is readable by the application."],
-    /// );
-    ///
-    /// // Prints "is_user?: true"
-    /// println!("is_user?: {}", err.is(human_errors::Kind::User));
-    /// ```
-    pub fn is(&self, kind: Kind) -> bool {
-        self.kind == kind
-    }
 }
 
 impl error::Error for Error {
diff --git a/src/kind.rs b/src/kind.rs
@@ -0,0 +1,41 @@
+
+/// The kind of error which occurred.
+///
+/// Distinguishes between errors which were the result of user actions
+/// and those which were the result of system failures. Conceptually
+/// similar to HTTP status codes in that 4xx errors are user-caused
+/// and 5xx errors are system-caused.
+#[derive(Debug, PartialEq, Eq)]
+pub enum Kind {
+    /// An error which was the result of actions that the user took.
+    ///
+    /// These errors are usually things which a user can easily resolve by
+    /// changing how they interact with the system. Advice should be used
+    /// to guide the user to the correct interaction paths and help them
+    /// self-mitigate without needing to open support tickets.
+    ///
+    /// These errors are usually generated with [`crate::user`], [`crate::user_with_cause`]
+    /// and [`crate::user_with_internal`].
+    User,
+
+    /// An error which was the result of the system failing rather than the user's actions.
+    ///
+    /// These kinds of issues are usually the result of the system entering
+    /// an unexpected state and/or violating an assumption on behalf of the
+    /// developer. Often these issues cannot be resolved by the user directly,
+    /// so the advice should guide them to the best way to raise a bug with you
+    /// and provide you with information to help them fix the issue.
+    ///
+    /// These errors are usually generated with [`crate::system`], [`crate::system_with_cause`]
+    /// and [`crate::system_with_internal`].
+    System,
+}
+
+impl Kind {
+    pub(crate) fn format_description(&self, description: &str) -> String {
+        match self {
+            Kind::User => format!("{description} (User error)"),
+            Kind::System => format!("{description} (System failure)"),
+        }
+    }
+}
diff --git a/src/lib.rs b/src/lib.rs
@@ -8,10 +8,12 @@
 mod error;
 mod from;
 mod helpers;
+mod kind;
 mod result;
 mod wrapper;
 
 pub use error::*;
 pub use helpers::*;
+pub use kind::*;
 pub use result::ResultExt;
 pub use wrapper::*;
