aboutsummaryrefslogtreecommitdiff
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
parent67585a4ffab14ba7c4b7c6dca530c177059a91d9 (diff)
downloadgarage-a2e1617d845e72c44b07f782801549f209ce14cc.tar.gz
garage-a2e1617d845e72c44b07f782801549f209ce14cc.zip
document web crate
-rw-r--r--src/garage/server.rs4
-rw-r--r--src/web/error.rs9
-rw-r--r--src/web/lib.rs5
-rw-r--r--src/web/web_server.rs1
4 files changed, 15 insertions, 4 deletions
diff --git a/src/garage/server.rs b/src/garage/server.rs
index feb858e4..a5bf68a6 100644
--- a/src/garage/server.rs
+++ b/src/garage/server.rs
@@ -11,7 +11,7 @@ use garage_util::error::Error;
use garage_api::api_server;
use garage_model::garage::Garage;
use garage_rpc::rpc_server::RpcServer;
-use garage_web::web_server;
+use garage_web::run_web_server;
use crate::admin_rpc::*;
@@ -63,7 +63,7 @@ pub async fn run_server(config_file: PathBuf) -> Result<(), Error> {
info!("Initializing RPC and API servers...");
let run_rpc_server = Arc::new(rpc_server).run(wait_from(watch_cancel.clone()));
let api_server = api_server::run_api_server(garage.clone(), wait_from(watch_cancel.clone()));
- let web_server = web_server::run_web_server(garage, wait_from(watch_cancel.clone()));
+ let web_server = run_web_server(garage, wait_from(watch_cancel.clone()));
futures::try_join!(
bootstrap.map(|rv| {
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 = ()>,