Add prelude (#567)

msrd0 · web-flow · commit 6238958403f4 · 2021-11-12T19:50:36.000Z
diff --git a/examples/cookies/introduction/src/main.rs b/examples/cookies/introduction/src/main.rs
@@ -7,9 +7,9 @@ use gotham::hyper::{Body, Response, StatusCode};
 use gotham::middleware::cookie::CookieParser;
 use gotham::mime::TEXT_PLAIN;
 use gotham::pipeline::{new_pipeline, single_pipeline};
-use gotham::router::builder::*;
-use gotham::router::Router;
-use gotham::state::{FromState, State};
+use gotham::prelude::*;
+use gotham::router::{build_router, Router};
+use gotham::state::State;
 
 /// The first request will set a cookie, and subsequent requests will echo it back.
 fn handler(state: State) -> (State, Response<Body>) {
diff --git a/examples/custom_service/src/main.rs b/examples/custom_service/src/main.rs
@@ -5,8 +5,8 @@ use futures_util::future::{BoxFuture, FutureExt};
 use gotham::hyper::server::conn::Http;
 use gotham::hyper::service::Service;
 use gotham::hyper::{Body, Request, Response};
-use gotham::router::builder::*;
-use gotham::router::Router;
+use gotham::prelude::*;
+use gotham::router::{build_simple_router, Router};
 use gotham::service::call_handler;
 use gotham::state::State;
 use std::net::SocketAddr;
diff --git a/examples/diesel/src/main.rs b/examples/diesel/src/main.rs
@@ -10,14 +10,14 @@ extern crate diesel_migrations;
 use diesel::prelude::*;
 use diesel::sqlite::SqliteConnection;
 use futures_util::FutureExt;
-use gotham::handler::{HandlerError, HandlerFuture, MapHandlerError, MapHandlerErrorFuture};
+use gotham::handler::{HandlerError, HandlerFuture};
 use gotham::helpers::http::response::create_response;
 use gotham::hyper::{body, Body, StatusCode};
 use gotham::mime::APPLICATION_JSON;
 use gotham::pipeline::{new_pipeline, single_pipeline};
-use gotham::router::builder::*;
-use gotham::router::Router;
-use gotham::state::{FromState, State};
+use gotham::prelude::*;
+use gotham::router::{build_router, Router};
+use gotham::state::State;
 use gotham_middleware_diesel::DieselMiddleware;
 use serde::Serialize;
 use std::pin::Pin;
diff --git a/examples/example_contribution_template/name/src/main.rs b/examples/example_contribution_template/name/src/main.rs
@@ -21,8 +21,8 @@
 //! you're writing an example for setting Cookies.
 use gotham::helpers::http::response::create_empty_response;
 use gotham::hyper::{Body, Response, StatusCode};
-use gotham::router::builder::*;
-use gotham::router::Router;
+use gotham::prelude::*;
+use gotham::router::{build_simple_router, Router};
 use gotham::state::State;
 
 /// Create a `Handler` that ...
diff --git a/examples/finalizers/src/main.rs b/examples/finalizers/src/main.rs
@@ -1,9 +1,9 @@
 //! An finalizer example
 use gotham::hyper::body::Body;
 use gotham::hyper::{Response, StatusCode};
-use gotham::router::builder::*;
+use gotham::prelude::*;
 use gotham::router::response::ResponseExtender;
-use gotham::router::Router;
+use gotham::router::{build_simple_router, Router};
 use gotham::state::State;
 
 const HELLO_ROUTER: &str = "Hello Router!";
diff --git a/examples/handlers/async_handlers/src/main.rs b/examples/handlers/async_handlers/src/main.rs
@@ -12,10 +12,10 @@ use gotham::hyper::StatusCode;
 #[cfg(not(test))]
 use gotham::hyper::{body, Client, Uri};
 use gotham::mime::TEXT_PLAIN;
-use gotham::router::builder::{build_simple_router, DefineSingleRoute, DrawRoutes};
-use gotham::router::response::StaticResponseExtender;
+use gotham::prelude::*;
+use gotham::router::builder::build_simple_router;
 use gotham::router::Router;
-use gotham::state::{FromState, State, StateData};
+use gotham::state::State;
 
 type ResponseContentFuture =
     Pin<Box<dyn Future<Output = Result<Vec<u8>, gotham::hyper::Error>> + Send>>;
diff --git a/examples/handlers/form_urlencoded/src/main.rs b/examples/handlers/form_urlencoded/src/main.rs
@@ -1,15 +1,17 @@
 //! An example of decoding requests from an HTML form element
+
 use futures_util::future::{self, FutureExt};
+use std::pin::Pin;
+use url::form_urlencoded;
 
 use gotham::handler::HandlerFuture;
 use gotham::helpers::http::response::create_response;
 use gotham::hyper::{body, Body, StatusCode};
 use gotham::mime::TEXT_PLAIN;
-use gotham::router::builder::{build_simple_router, DefineSingleRoute, DrawRoutes};
+use gotham::prelude::*;
+use gotham::router::builder::build_simple_router;
 use gotham::router::Router;
-use gotham::state::{FromState, State};
-use std::pin::Pin;
-use url::form_urlencoded;
+use gotham::state::State;
 
 /// Extracts the elements of the POST request and responds with the form keys and values
 fn form_handler(mut state: State) -> Pin<Box<HandlerFuture>> {
diff --git a/examples/handlers/multipart/src/main.rs b/examples/handlers/multipart/src/main.rs
@@ -5,9 +5,10 @@ use gotham::helpers::http::response::create_response;
 use gotham::hyper::header::CONTENT_TYPE;
 use gotham::hyper::{body, Body, HeaderMap, StatusCode};
 use gotham::mime::TEXT_PLAIN;
-use gotham::router::builder::{build_simple_router, DefineSingleRoute, DrawRoutes};
+use gotham::prelude::*;
+use gotham::router::builder::build_simple_router;
 use gotham::router::Router;
-use gotham::state::{FromState, State};
+use gotham::state::State;
 use multipart::server::Multipart;
 use std::io::{Cursor, Read};
 use std::pin::Pin;
diff --git a/examples/handlers/request_data/src/main.rs b/examples/handlers/request_data/src/main.rs
@@ -1,13 +1,14 @@
 //! A basic example showing the request components
 use futures_util::future::{self, FutureExt};
-use gotham::hyper::{body, Body, HeaderMap, Method, Response, StatusCode, Uri, Version};
 use std::pin::Pin;
 
 use gotham::handler::HandlerFuture;
 use gotham::helpers::http::response::create_empty_response;
-use gotham::router::builder::{build_simple_router, DefineSingleRoute, DrawRoutes};
+use gotham::hyper::{body, Body, HeaderMap, Method, Response, StatusCode, Uri, Version};
+use gotham::prelude::*;
+use gotham::router::builder::build_simple_router;
 use gotham::router::Router;
-use gotham::state::{FromState, State};
+use gotham::state::State;
 
 /// Extract the main elements of the request except for the `Body`
 fn print_request_elements(state: &State) {
diff --git a/examples/handlers/simple_async_handlers/src/main.rs b/examples/handlers/simple_async_handlers/src/main.rs
@@ -11,10 +11,10 @@ use gotham::handler::HandlerFuture;
 use gotham::helpers::http::response::create_response;
 use gotham::hyper::StatusCode;
 use gotham::mime::TEXT_PLAIN;
-use gotham::router::builder::{build_simple_router, DefineSingleRoute, DrawRoutes};
-use gotham::router::response::StaticResponseExtender;
+use gotham::prelude::*;
+use gotham::router::builder::build_simple_router;
 use gotham::router::Router;
-use gotham::state::{FromState, State, StateData};
+use gotham::state::State;
 
 #[derive(Deserialize, StateData, StaticResponseExtender)]
 struct QueryStringExtractor {
diff --git a/examples/handlers/simple_async_handlers_await/src/main.rs b/examples/handlers/simple_async_handlers_await/src/main.rs
@@ -1,13 +1,13 @@
 //! A basic example showing the request components
 
-use gotham::handler::{HandlerError, HandlerResult, IntoResponse};
+use gotham::handler::{HandlerError, HandlerResult};
 use gotham::helpers::http::response::create_response;
 use gotham::hyper::{Body, StatusCode};
 use gotham::mime::TEXT_PLAIN;
-use gotham::router::builder::{build_simple_router, DefineSingleRoute, DrawRoutes};
-use gotham::router::response::StaticResponseExtender;
+use gotham::prelude::*;
+use gotham::router::builder::build_simple_router;
 use gotham::router::Router;
-use gotham::state::{FromState, State, StateData};
+use gotham::state::State;
 use serde::Deserialize;
 use std::time::Duration;
 use tokio::time::sleep;
diff --git a/examples/handlers/stateful/src/main.rs b/examples/handlers/stateful/src/main.rs
@@ -7,10 +7,10 @@ use std::pin::Pin;
 use std::sync::{Arc, Mutex};
 use std::time::SystemTime;
 
-use gotham::anyhow::Result;
-use gotham::handler::{Handler, HandlerFuture, IntoResponse, NewHandler};
-use gotham::router::builder::*;
-use gotham::router::Router;
+use gotham::anyhow;
+use gotham::handler::{Handler, HandlerFuture, NewHandler};
+use gotham::prelude::*;
+use gotham::router::{build_simple_router, Router};
 use gotham::state::State;
 
 // A struct which can store the state which it needs.
@@ -61,7 +61,7 @@ impl Handler for CountingHandler {
 impl NewHandler for CountingHandler {
     type Instance = Self;
 
-    fn new_handler(&self) -> Result<Self::Instance> {
+    fn new_handler(&self) -> anyhow::Result<Self::Instance> {
         Ok(self.clone())
     }
 }
diff --git a/examples/headers/setting/src/main.rs b/examples/headers/setting/src/main.rs
@@ -1,8 +1,8 @@
 //! Setting a header value for a Gotham web framework response
 use gotham::helpers::http::response::create_empty_response;
 use gotham::hyper::{Body, Response, StatusCode};
-use gotham::router::builder::*;
-use gotham::router::Router;
+use gotham::prelude::*;
+use gotham::router::{build_simple_router, Router};
 use gotham::state::State;
 
 /// Create a `Handler` that adds a custom header.
diff --git a/examples/into_response/introduction/src/main.rs b/examples/into_response/introduction/src/main.rs
@@ -1,11 +1,10 @@
 //! An introduction to the Gotham web framework's `IntoResponse` trait.
 
-use gotham::handler::IntoResponse;
 use gotham::helpers::http::response::create_response;
 use gotham::hyper::{Body, Response, StatusCode};
 use gotham::mime::APPLICATION_JSON;
-use gotham::router::builder::*;
-use gotham::router::Router;
+use gotham::prelude::*;
+use gotham::router::{build_simple_router, Router};
 use gotham::state::State;
 use serde::Serialize;
 
diff --git a/examples/middleware/introduction/src/main.rs b/examples/middleware/introduction/src/main.rs
@@ -7,11 +7,11 @@ use gotham::handler::HandlerFuture;
 use gotham::helpers::http::response::create_empty_response;
 use gotham::hyper::header::{HeaderMap, USER_AGENT};
 use gotham::hyper::{Body, Response, StatusCode};
-use gotham::middleware::{Middleware, NewMiddleware};
+use gotham::middleware::Middleware;
 use gotham::pipeline::{new_pipeline, single_pipeline};
-use gotham::router::builder::*;
-use gotham::router::Router;
-use gotham::state::{FromState, State, StateData};
+use gotham::prelude::*;
+use gotham::router::{build_router, Router};
+use gotham::state::State;
 
 /// A simple struct which holds an identifier for the user agent which made the request.
 ///
diff --git a/examples/middleware/introduction_await/src/main.rs b/examples/middleware/introduction_await/src/main.rs
@@ -6,11 +6,11 @@ use gotham::handler::HandlerFuture;
 use gotham::helpers::http::response::create_empty_response;
 use gotham::hyper::header::{HeaderMap, USER_AGENT};
 use gotham::hyper::{Body, Response, StatusCode};
-use gotham::middleware::{Middleware, NewMiddleware};
+use gotham::middleware::Middleware;
 use gotham::pipeline::{new_pipeline, single_pipeline};
-use gotham::router::builder::*;
-use gotham::router::Router;
-use gotham::state::{FromState, State, StateData};
+use gotham::prelude::*;
+use gotham::router::{build_router, Router};
+use gotham::state::State;
 
 /// A simple struct which holds an identifier for the user agent which made the request.
 ///
diff --git a/examples/middleware/multiple_pipelines/src/main.rs b/examples/middleware/multiple_pipelines/src/main.rs
@@ -20,11 +20,11 @@ use std::pin::Pin;
 use gotham::handler::HandlerFuture;
 use gotham::helpers::http::response::create_response;
 use gotham::middleware::session::NewSessionMiddleware;
-use gotham::middleware::{Middleware, NewMiddleware};
+use gotham::middleware::Middleware;
 use gotham::pipeline::{finalize_pipeline_set, new_pipeline, new_pipeline_set, single_pipeline};
-use gotham::router::builder::*;
-use gotham::router::Router;
-use gotham::state::{FromState, State};
+use gotham::prelude::*;
+use gotham::router::{build_router, Router};
+use gotham::state::State;
 use serde::{Deserialize, Serialize};
 
 /// A simple struct to represent our default session data.
diff --git a/examples/path/globs/src/main.rs b/examples/path/globs/src/main.rs
@@ -1,9 +1,8 @@
 //! Shows how to match arbitrarily many path segments.
 
-use gotham::router::builder::*;
-use gotham::router::response::StaticResponseExtender;
-use gotham::router::Router;
-use gotham::state::{FromState, State, StateData};
+use gotham::prelude::*;
+use gotham::router::{build_simple_router, Router};
+use gotham::state::State;
 use serde::Deserialize;
 
 #[derive(Deserialize, StateData, StaticResponseExtender)]
diff --git a/examples/path/introduction/src/main.rs b/examples/path/introduction/src/main.rs
@@ -1,10 +1,9 @@
 //! An introduction to extracting request path segments, in a type safe way, with the
 //! Gotham web framework
 
-use gotham::router::builder::*;
-use gotham::router::response::StaticResponseExtender;
-use gotham::router::Router;
-use gotham::state::{FromState, State, StateData};
+use gotham::prelude::*;
+use gotham::router::{build_simple_router, Router};
+use gotham::state::State;
 use serde::Deserialize;
 
 /// Holds data extracted from the Request path.
diff --git a/examples/path/regex/src/main.rs b/examples/path/regex/src/main.rs
@@ -1,9 +1,8 @@
 //! An example of the Gotham web framework `Router` that shows how to use Regex patterns in path segments.
 
-use gotham::router::builder::*;
-use gotham::router::response::StaticResponseExtender;
-use gotham::router::Router;
-use gotham::state::{FromState, State, StateData};
+use gotham::prelude::*;
+use gotham::router::{build_simple_router, Router};
+use gotham::state::State;
 use serde::Deserialize;
 
 #[derive(Deserialize, StateData, StaticResponseExtender)]
diff --git a/examples/query_string/introduction/src/main.rs b/examples/query_string/introduction/src/main.rs
@@ -2,10 +2,9 @@
 //! Gotham web framework
 
 use gotham::mime::{Mime, APPLICATION_JSON};
-use gotham::router::builder::*;
-use gotham::router::response::StaticResponseExtender;
-use gotham::router::Router;
-use gotham::state::{FromState, State, StateData};
+use gotham::prelude::*;
+use gotham::router::{build_simple_router, Router};
+use gotham::state::State;
 use serde::{Deserialize, Serialize};
 
 /// Holds data extracted from the Request query string.
diff --git a/examples/routing/associations/src/handlers.rs b/examples/routing/associations/src/handlers.rs
@@ -3,7 +3,7 @@
 //! We've used a macro here for brevity but this is NOT how you would implement a handler in
 //! a real world application.
 
-use gotham::handler::IntoResponse;
+use gotham::prelude::*;
 use gotham::state::State;
 
 macro_rules! generic_handler {
diff --git a/examples/routing/associations/src/main.rs b/examples/routing/associations/src/main.rs
@@ -1,8 +1,8 @@
 //! An example of the Gotham web framework `Router` that shows how to associate multiple handlers
 //! to a single path.
 use gotham::hyper::Method;
-use gotham::router::builder::*;
-use gotham::router::Router;
+use gotham::prelude::*;
+use gotham::router::{build_simple_router, Router};
 
 mod handlers;
 use self::handlers::*;
diff --git a/examples/routing/http_verbs/src/handlers.rs b/examples/routing/http_verbs/src/handlers.rs
@@ -3,7 +3,7 @@
 //! We've used a macro here for brevity but this is NOT how you would implement a handler in
 //! a real world application.
 
-use gotham::handler::IntoResponse;
+use gotham::prelude::*;
 use gotham::state::State;
 
 macro_rules! generic_handler {
diff --git a/examples/routing/http_verbs/src/main.rs b/examples/routing/http_verbs/src/main.rs
@@ -1,8 +1,8 @@
 //! An example of the Gotham web framework Router that shows how to route requests to handlers
 //! based on HTTP verbs.
 use gotham::hyper::Method;
-use gotham::router::builder::*;
-use gotham::router::Router;
+use gotham::prelude::*;
+use gotham::router::{build_simple_router, Router};
 
 mod handlers;
 use self::handlers::*;
diff --git a/examples/routing/introduction/src/main.rs b/examples/routing/introduction/src/main.rs
@@ -1,6 +1,6 @@
 //! An introduction to fundamental `Router` and `Router Builder` concepts to create a routing tree.
-use gotham::router::builder::*;
-use gotham::router::Router;
+use gotham::prelude::*;
+use gotham::router::{build_simple_router, Router};
 use gotham::state::State;
 
 const HELLO_ROUTER: &str = "Hello Router!";
diff --git a/examples/routing/scopes/src/handlers.rs b/examples/routing/scopes/src/handlers.rs
@@ -3,7 +3,7 @@
 //! We've used a macro here for brevity but this is NOT how you would implement a handler in
 //! a real world application.
 
-use gotham::handler::IntoResponse;
+use gotham::prelude::*;
 use gotham::state::State;
 
 macro_rules! generic_handler {
diff --git a/examples/routing/scopes/src/main.rs b/examples/routing/scopes/src/main.rs
@@ -1,8 +1,8 @@
 //!  An example of the Gotham web framework `Router` that shows how to combine `Routes`
 //!  under a common root using scopes.
 use gotham::hyper::Method;
-use gotham::router::builder::*;
-use gotham::router::Router;
+use gotham::prelude::*;
+use gotham::router::{build_simple_router, Router};
 
 mod handlers;
 use self::handlers::*;
diff --git a/examples/sessions/custom_data_type/src/main.rs b/examples/sessions/custom_data_type/src/main.rs
@@ -3,9 +3,9 @@
 
 use gotham::middleware::session::{NewSessionMiddleware, SessionData};
 use gotham::pipeline::{new_pipeline, single_pipeline};
-use gotham::router::builder::*;
-use gotham::router::Router;
-use gotham::state::{FromState, State, StateData};
+use gotham::prelude::*;
+use gotham::router::{build_router, Router};
+use gotham::state::State;
 use serde::{Deserialize, Serialize};
 use time::format_description::well_known::Rfc3339;
 use time::OffsetDateTime;
diff --git a/examples/sessions/introduction/src/main.rs b/examples/sessions/introduction/src/main.rs
diff --git a/examples/shared_state/src/main.rs b/examples/shared_state/src/main.rs
diff --git a/examples/static_assets/src/main.rs b/examples/static_assets/src/main.rs
diff --git a/examples/websocket/src/main.rs b/examples/websocket/src/main.rs
diff --git a/gotham/src/extractor/path.rs b/gotham/src/extractor/path.rs
diff --git a/gotham/src/extractor/query_string.rs b/gotham/src/extractor/query_string.rs
diff --git a/gotham/src/lib.rs b/gotham/src/lib.rs
diff --git a/gotham/src/prelude.rs b/gotham/src/prelude.rs
diff --git a/gotham/src/router/builder/associated.rs b/gotham/src/router/builder/associated.rs
diff --git a/gotham/src/router/builder/single.rs b/gotham/src/router/builder/single.rs
diff --git a/gotham/src/router/mod.rs b/gotham/src/router/mod.rs
diff --git a/middleware/diesel/src/repo.rs b/middleware/diesel/src/repo.rs
diff --git a/middleware/jwt/src/state_data.rs b/middleware/jwt/src/state_data.rs
