Move error types to mod 'errors' (#35)

examples/18_error_type_passthrough.rs

@@ -3,7 +3,10 @@
 
 use env_logger::{Builder, Env};
 use tokio::time::{sleep, Duration};
-use tokio_graceful_shutdown::{GracefulShutdownError, IntoSubsystem, SubsystemHandle, Toplevel};
+use tokio_graceful_shutdown::{
+    errors::{GracefulShutdownError, SubsystemError},
+    IntoSubsystem, SubsystemHandle, Toplevel,
+};
 
 #[derive(Debug, thiserror::Error)]
 enum MyError {
@@ -57,6 +60,10 @@ async fn subsys5(_subsys: SubsystemHandle<MyError>) -> Result<(), MyError> {
     Ok(())
 }
 
+// This subsystem implements the IntoSubsystem trait with a custom error type.
+// The first generic is the error type returned from the `run()` function, the
+// second generic is the error wrapper type used by Toplevel. In this case,
+// both are identical.
 struct Subsys6;
 
 #[async_trait::async_trait]
@@ -99,7 +106,7 @@ async fn main() -> Result<(), miette::Report> {
 
         for subsystem_error in e.get_subsystem_errors() {
             match subsystem_error {
-                tokio_graceful_shutdown::SubsystemError::Failed(name, e) => {
+                SubsystemError::Failed(name, e) => {
                     log::warn!("   Subsystem '{}' failed.", name);
                     match e.get_error() {
                         MyError::WithData(data) => {
@@ -110,10 +117,10 @@ async fn main() -> Result<(), miette::Report> {
                         }
                     }
                 }
-                tokio_graceful_shutdown::SubsystemError::Cancelled(name) => {
+                SubsystemError::Cancelled(name) => {
                     log::warn!("   Subsystem '{}' was cancelled.", name)
                 }
-                tokio_graceful_shutdown::SubsystemError::Panicked(name) => {
+                SubsystemError::Panicked(name) => {
                     log::warn!("   Subsystem '{}' panicked.", name)
                 }
             }

src/errors.rs

@@ -1,3 +1,5 @@
+//! All the errors that can be caused by this crate.
+
 use miette::Diagnostic;
 use thiserror::Error;
 

src/lib.rs

@@ -102,7 +102,7 @@ impl<T> ErrTypeTraits for T where
 {
 }
 
-mod errors;
+pub mod errors;
 mod exit_state;
 mod into_subsystem;
 mod runner;
@@ -112,10 +112,6 @@ mod subsystem;
 mod toplevel;
 mod utils;
 
-pub use errors::GracefulShutdownError;
-pub use errors::PartialShutdownError;
-pub use errors::SubsystemError;
-pub use errors::SubsystemFailure;
 pub use into_subsystem::IntoSubsystem;
 pub use shutdown_token::ShutdownToken;
 pub use subsystem::NestedSubsystem;

src/runner.rs

@@ -1,4 +1,8 @@
-use crate::{utils::ShutdownGuard, ErrTypeTraits, ShutdownToken, SubsystemError, SubsystemFailure};
+use crate::{
+    errors::{SubsystemError, SubsystemFailure},
+    utils::ShutdownGuard,
+    ErrTypeTraits, ShutdownToken,
+};
 use std::{future::Future, sync::Arc};
 use tokio::task::{JoinError, JoinHandle};
 use tokio_util::sync::CancellationToken;

src/subsystem/data.rs

@@ -13,13 +13,13 @@ use super::PartialShutdownError;
 use super::SubsystemData;
 use super::SubsystemDescriptor;
 use super::SubsystemIdentifier;
+use crate::errors::SubsystemError;
 use crate::exit_state::prettify_exit_states;
 use crate::exit_state::{join_shutdown_results, ShutdownResults, SubprocessExitState};
 use crate::runner::SubsystemRunner;
 use crate::shutdown_token::ShutdownToken;
 use crate::utils::ShutdownGuard;
 use crate::ErrTypeTraits;
-use crate::SubsystemError;
 
 impl<ErrType: ErrTypeTraits> SubsystemData<ErrType> {
     pub fn new(

src/subsystem/handle.rs

@@ -4,9 +4,9 @@ use std::sync::Arc;
 use super::NestedSubsystem;
 use super::SubsystemData;
 use super::SubsystemHandle;
+use crate::errors::PartialShutdownError;
 use crate::runner::SubsystemRunner;
 use crate::ErrTypeTraits;
-use crate::PartialShutdownError;
 use crate::ShutdownToken;
 
 #[cfg(doc)]

src/subsystem/mod.rs

@@ -8,11 +8,11 @@ use std::sync::Weak;
 
 use tokio_util::sync::CancellationToken;
 
+use crate::errors::PartialShutdownError;
 use crate::runner::SubsystemRunner;
 use crate::shutdown_token::ShutdownToken;
 use crate::utils::ShutdownGuard;
 use crate::ErrTypeTraits;
-use crate::PartialShutdownError;
 
 use self::identifier::SubsystemIdentifier;
 

src/toplevel.rs

@@ -6,13 +6,13 @@ use std::time::Duration;
 
 use tokio_util::sync::CancellationToken;
 
+use crate::errors::GracefulShutdownError;
 use crate::exit_state::prettify_exit_states;
 use crate::shutdown_token::create_shutdown_token;
 use crate::signal_handling::wait_for_signal;
 use crate::utils::wait_forever;
 use crate::utils::ShutdownGuard;
 use crate::ErrTypeTraits;
-use crate::GracefulShutdownError;
 use crate::{ShutdownToken, SubsystemHandle};
 
 use super::subsystem::SubsystemData;

tests/integration_test.rs

@@ -2,8 +2,8 @@ use anyhow::anyhow;
 use env_logger;
 use tokio::time::{sleep, timeout, Duration};
 use tokio_graceful_shutdown::{
-    GracefulShutdownError, IntoSubsystem, PartialShutdownError, SubsystemError, SubsystemHandle,
-    Toplevel,
+    errors::{GracefulShutdownError, PartialShutdownError, SubsystemError},
+    IntoSubsystem, SubsystemHandle, Toplevel,
 };
 
 mod common;