aboutsummaryrefslogtreecommitdiff
path: root/src/web/error.rs
diff options
context:
space:
mode:
authorTrinity Pointard <trinity.pointard@gmail.com>2021-03-26 22:05:16 +0100
committerAlex Auvolat <alex@adnab.me>2021-04-27 16:37:10 +0200
commita2e1617d845e72c44b07f782801549f209ce14cc (patch)
tree0aaa74ba86c724fe949c7c5005654619d6f37f81 /src/web/error.rs
parent67585a4ffab14ba7c4b7c6dca530c177059a91d9 (diff)
downloadgarage-a2e1617d845e72c44b07f782801549f209ce14cc.tar.gz
garage-a2e1617d845e72c44b07f782801549f209ce14cc.zip
document web crate
Diffstat (limited to 'src/web/error.rs')
-rw-r--r--src/web/error.rs9
1 files changed, 8 insertions, 1 deletions
diff --git a/src/web/error.rs b/src/web/error.rs
index 14bc3b75..6da86199 100644
--- a/src/web/error.rs
+++ b/src/web/error.rs
@@ -3,30 +3,37 @@ use hyper::StatusCode;
use garage_util::error::Error as GarageError;
+/// Errors of this crate
#[derive(Debug, Error)]
pub enum Error {
+ /// An error received from the API crate
#[error(display = "API error: {}", _0)]
ApiError(#[error(source)] garage_api::error::Error),
// Category: internal error
+ /// Error internal to garage
#[error(display = "Internal error: {}", _0)]
InternalError(#[error(source)] GarageError),
+ /// The file does not exist
#[error(display = "Not found")]
NotFound,
- // Category: bad request
+ /// The client requested a malformed path
#[error(display = "Invalid UTF-8: {}", _0)]
InvalidUTF8(#[error(source)] std::str::Utf8Error),
+ /// The client send a header with invalid value
#[error(display = "Invalid header value: {}", _0)]
InvalidHeader(#[error(source)] hyper::header::ToStrError),
+ /// The client sent a request without host, or with unsupported method
#[error(display = "Bad request: {}", _0)]
BadRequest(String),
}
impl Error {
+ /// Transform errors into http status code
pub fn http_status_code(&self) -> StatusCode {
match self {
Error::NotFound => StatusCode::NOT_FOUND,