aboutsummaryrefslogtreecommitdiff
path: root/src/api/error.rs
diff options
context:
space:
mode:
authorTrinity Pointard <trinity.pointard@gmail.com>2021-03-26 22:32:09 +0100
committerAlex Auvolat <alex@adnab.me>2021-04-27 16:37:10 +0200
commit1e3df189d0dc37880219338c53607152ae0c87e0 (patch)
treedb1a0ccea1b29c8916ed3246ff71ea66b3323bac /src/api/error.rs
parenta2e1617d845e72c44b07f782801549f209ce14cc (diff)
downloadgarage-1e3df189d0dc37880219338c53607152ae0c87e0.tar.gz
garage-1e3df189d0dc37880219338c53607152ae0c87e0.zip
document api crate
Diffstat (limited to 'src/api/error.rs')
-rw-r--r--src/api/error.rs16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/api/error.rs b/src/api/error.rs
index 42a7ab10..acd8ebf7 100644
--- a/src/api/error.rs
+++ b/src/api/error.rs
@@ -3,44 +3,57 @@ use hyper::StatusCode;
use garage_util::error::Error as GarageError;
+/// Errors of this crate
#[derive(Debug, Error)]
pub enum Error {
// Category: internal error
+ /// Error related to deeper parts of Garage
#[error(display = "Internal error: {}", _0)]
InternalError(#[error(source)] GarageError),
+ /// Error related to Hyper
#[error(display = "Internal error (Hyper error): {}", _0)]
Hyper(#[error(source)] hyper::Error),
+ /// Error related to HTTP
#[error(display = "Internal error (HTTP error): {}", _0)]
HTTP(#[error(source)] http::Error),
// Category: cannot process
+ /// No proper api key was used, or the signature was invalid
#[error(display = "Forbidden: {}", _0)]
Forbidden(String),
+ /// The object requested don't exists
#[error(display = "Not found")]
NotFound,
// Category: bad request
+ /// The request used an invalid path
#[error(display = "Invalid UTF-8: {}", _0)]
InvalidUTF8Str(#[error(source)] std::str::Utf8Error),
+ /// The request used an invalid path
#[error(display = "Invalid UTF-8: {}", _0)]
InvalidUTF8String(#[error(source)] std::string::FromUtf8Error),
+ /// Some base64 encoded data was badly encoded
#[error(display = "Invalid base64: {}", _0)]
InvalidBase64(#[error(source)] base64::DecodeError),
+ /// The client sent invalid XML data
#[error(display = "Invalid XML: {}", _0)]
InvalidXML(String),
+ /// The client sent a header with invalid value
#[error(display = "Invalid header value: {}", _0)]
InvalidHeader(#[error(source)] hyper::header::ToStrError),
+ /// The client sent a range header with invalid value
#[error(display = "Invalid HTTP range: {:?}", _0)]
InvalidRange(#[error(from)] http_range::HttpRangeParseError),
+ /// The client sent an invalid request
#[error(display = "Bad request: {}", _0)]
BadRequest(String),
}
@@ -52,6 +65,7 @@ impl From<roxmltree::Error> for Error {
}
impl Error {
+ /// Convert an error into an Http status code
pub fn http_status_code(&self) -> StatusCode {
match self {
Error::NotFound => StatusCode::NOT_FOUND,
@@ -65,6 +79,7 @@ impl Error {
}
}
+/// Trait to map error to the Bad Request error code
pub trait OkOrBadRequest {
type S2;
fn ok_or_bad_request(self, reason: &'static str) -> Self::S2;
@@ -93,6 +108,7 @@ impl<T> OkOrBadRequest for Option<T> {
}
}
+/// Trait to map an error to an Internal Error code
pub trait OkOrInternalError {
type S2;
fn ok_or_internal_error(self, reason: &'static str) -> Self::S2;