Clean up Error handling.

* Implement `std::error::Error` for the new Error type.
* Document the new Error type.
* Remove `LaunchError`'s implementation of `Error::description`, which is deprecated.
This commit is contained in:
Jeb Rosen 2020-01-15 16:13:12 -08:00 committed by Sergio Benitez
parent 70db7fb2ea
commit d5483cb196
2 changed files with 19 additions and 36 deletions

View File

@ -5,24 +5,37 @@ use std::sync::atomic::{Ordering, AtomicBool};
use yansi::Paint;
use crate::http::hyper;
use crate::router::Route;
// TODO.async docs
/// An error that occurs when running a Rocket server.
///
/// Errors can happen immediately upon launch ([`LaunchError`])
/// or more rarely during the server's execution.
#[derive(Debug)]
pub enum Error {
Launch(LaunchError),
Run(hyper::Error),
Run(Box<dyn std::error::Error + Send + Sync>),
}
impl fmt::Display for Error {
#[inline]
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Error::Launch(e) => write!(f, "Rocket failed to launch: {}", e),
Error::Run(e) => write!(f, "error while running server: {}", e),
}
}
}
impl std::error::Error for Error { }
/// The kind of launch error that occurred.
///
/// In almost every instance, a launch error occurs because of an I/O error;
/// this is represented by the `Io` variant. A launch error may also occur
/// because of ill-defined routes that lead to collisions or because a fairing
/// encountered an error; these are represented by the `Collision` and
/// `FailedFairing` variants, respectively. The `Unknown` variant captures all
/// other kinds of launch errors.
/// `FailedFairing` variants, respectively.
#[derive(Debug)]
pub enum LaunchErrorKind {
/// Binding to the provided address/port failed.
@ -33,8 +46,6 @@ pub enum LaunchErrorKind {
Collision(Vec<(Route, Route)>),
/// A launch fairing reported an error.
FailedFairings(Vec<&'static str>),
/// An otherwise uncategorized error occurred during launch.
Unknown(Box<dyn std::error::Error + Send + Sync>)
}
/// An error that occurs during launch.
@ -141,15 +152,6 @@ impl LaunchError {
}
}
impl From<hyper::Error> for LaunchError {
#[inline]
fn from(error: hyper::Error) -> LaunchError {
// TODO.async: Should "hyper error" be another variant of LaunchErrorKind?
// Or should this use LaunchErrorKind::Io?
LaunchError::new(LaunchErrorKind::Unknown(Box::new(error)))
}
}
impl From<io::Error> for LaunchError {
#[inline]
fn from(error: io::Error) -> LaunchError {
@ -165,7 +167,6 @@ impl fmt::Display for LaunchErrorKind {
LaunchErrorKind::Io(ref e) => write!(f, "I/O error: {}", e),
LaunchErrorKind::Collision(_) => write!(f, "route collisions detected"),
LaunchErrorKind::FailedFairings(_) => write!(f, "a launch fairing failed"),
LaunchErrorKind::Unknown(ref e) => write!(f, "unknown error: {}", e)
}
}
}
@ -186,20 +187,6 @@ impl fmt::Display for LaunchError {
}
}
impl std::error::Error for LaunchError {
#[inline]
fn description(&self) -> &str {
self.mark_handled();
match *self.kind() {
LaunchErrorKind::Bind(_) => "failed to bind to given address/port",
LaunchErrorKind::Io(_) => "an I/O error occurred during launch",
LaunchErrorKind::Collision(_) => "route collisions were detected",
LaunchErrorKind::FailedFairings(_) => "a launch fairing reported an error",
LaunchErrorKind::Unknown(_) => "an unknown error occurred during launch"
}
}
}
impl Drop for LaunchError {
fn drop(&mut self) {
if self.was_handled() {
@ -232,10 +219,6 @@ impl Drop for LaunchError {
panic!("launch fairing failure");
}
LaunchErrorKind::Unknown(ref e) => {
error!("Rocket failed to launch due to an unknown error.");
panic!("{}", e);
}
}
}
}

View File

@ -769,7 +769,7 @@ impl Rocket {
.serve(service)
.with_graceful_shutdown(async move { shutdown_receiver.recv().await; })
.await
.map_err(crate::error::Error::Run)
.map_err(|e| crate::error::Error::Run(Box::new(e)))
}
/// Returns a `Future` that drives the server and completes when the server