diff options
| author | Trinity Pointard <trinity.pointard@gmail.com> | 2021-03-26 22:05:16 +0100 |
|---|---|---|
| committer | Alex Auvolat <alex@adnab.me> | 2021-04-27 16:37:10 +0200 |
| commit | a2e1617d845e72c44b07f782801549f209ce14cc (patch) | |
| tree | 0aaa74ba86c724fe949c7c5005654619d6f37f81 /src/web | |
| parent | 67585a4ffab14ba7c4b7c6dca530c177059a91d9 (diff) | |
| download | garage-a2e1617d845e72c44b07f782801549f209ce14cc.tar.gz garage-a2e1617d845e72c44b07f782801549f209ce14cc.zip | |
document web crate
Diffstat (limited to 'src/web')
| -rw-r--r-- | src/web/error.rs | 9 | ||||
| -rw-r--r-- | src/web/lib.rs | 5 | ||||
| -rw-r--r-- | src/web/web_server.rs | 1 |
3 files changed, 13 insertions, 2 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, diff --git a/src/web/lib.rs b/src/web/lib.rs index 7d3b4d54..3e978af6 100644 --- a/src/web/lib.rs +++ b/src/web/lib.rs @@ -1,7 +1,10 @@ +#![deny(missing_crate_level_docs, missing_docs)] +//! Crate for handling web serving of s3 bucket #[macro_use] extern crate log; mod error; pub use error::Error; -pub mod web_server; +mod web_server; +pub use web_server::run_web_server; diff --git a/src/web/web_server.rs b/src/web/web_server.rs index cfde2bcc..9635eca6 100644 --- a/src/web/web_server.rs +++ b/src/web/web_server.rs @@ -18,6 +18,7 @@ use garage_model::garage::Garage; use garage_table::*; use garage_util::error::Error as GarageError; +/// Run a web server pub async fn run_web_server( garage: Arc<Garage>, shutdown_signal: impl Future<Output = ()>, |