1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
#![deny(rust_2018_idioms)] //! # HttpRouter //! //! [](https://docs.rs/httprouter/0.5.0) //! [](https://crates.io/crates/httprouter) //! [](https://crates.io/crates/httprouter) //! [](https://github.com/ibraheemdev/httprouter-rs/actions) //! //! HttpRouter is a lightweight high performance HTTP request router. //! //! This router supports variables in the routing pattern and matches against the request method. It also scales very well. //! //! The router is optimized for high performance and a small memory footprint. It scales well even with very long paths and a large number of routes. A compressing dynamic trie (radix tree) structure is used for efficient matching. Internally, it uses the [matchit](https://github.com/ibraheemdev/matchit) package. //! //! ## Features //! //! **Only explicit matches:** With other routers, a requested URL path could match multiple patterns. Therefore they have some awkward pattern priority rules, like *longest match* or *first registered, first matched*. By design of this router, a request can only match exactly one or no route. As a result, there are also no unintended matches, which makes it great for SEO and improves the user experience. //! //! **Path auto-correction:** Besides detecting the missing or additional trailing slash at no extra cost, the router can also fix wrong cases and remove superfluous path elements (like `../` or `//`). Is [CAPTAIN CAPS LOCK](http://www.urbandictionary.com/define.php?term=Captain+Caps+Lock) one of your users? HttpRouter can help him by making a case-insensitive look-up and redirecting him to the correct URL. //! //! **Parameters in your routing pattern:** Stop parsing the requested URL path, just give the path segment a name and the router delivers the dynamic value to you. Because of the design of the router, path parameters are very cheap. //! //! **High Performance:** HttpRouter relies on a tree structure which makes heavy use of *common prefixes*, it is basically a [radix tree](https://en.wikipedia.org/wiki/Radix_tree). This makes lookups extremely fast. Internally, it uses the [matchit](https://github.com/ibraheemdev/matchit) package. //! //! Of course you can also set **custom [`NotFound`](https://docs.rs/httprouter/newest/httprouter/router/struct.Router.html#method.not_found) and [`MethodNotAllowed`](https://docs.rs/httprouter/newest/httprouter/router/struct.Router.html#method.method_not_allowed) handlers** , [**serve static files**](https://docs.rs/httprouter/newest/httprouter/router/struct.Router.html#method.serve_files), and [**automatically respond to OPTIONS requests**](https://docs.rs/httprouter/newest/httprouter/router/struct.Router.html#method.global_options) //! //! ## Usage //! //! Here is a simple example: //! //! ```rust,no_run //! use httprouter::{Router, Params}; //! use hyper::{Request, Response, Body, Error}; //! //! async fn index(_: Request<Body>) -> Result<Response<Body>, Error> { //! Ok(Response::new("Hello, World!".into())) //! } //! //! async fn hello(req: Request<Body>) -> Result<Response<Body>, Error> { //! let params = req.extensions().get::<Params>().unwrap(); //! Ok(Response::new(format!("Hello, {}", params.get("user").unwrap()).into())) //! } //! //! #[tokio::main] //! async fn main() { //! let router = Router::default() //! .get("/", index) //! .get("/hello/:user", hello); //! //! hyper::Server::bind(&([127, 0, 0, 1], 3000).into()) //! .serve(router.into_service()) //! .await; //! } //! ``` //! //! ### Named parameters //! //! As you can see, `:user` is a *named parameter*. The values are accessible via `req.extensions().get::<Params>()`. //! //! Named parameters only match a single path segment: //! //! ```text //! Pattern: /user/:user //! //! /user/gordon match //! /user/you match //! /user/gordon/profile no match //! /user/ no match //! ``` //! //! **Note:** Since this router has only explicit matches, you can not register static routes and parameters for the same path segment. For example you can not register the patterns `/user/new` and `/user/:user` for the same request method at the same time. The routing of different request methods is independent from each other. //! //! ### Catch-All parameters //! //! The second type are *catch-all* parameters and have the form `*name`. Like the name suggests, they match everything. Therefore they must always be at the **end** of the pattern: //! //! ```text //! Pattern: /src/*filepath //! //! /src/ match //! /src/somefile.go match //! /src/subdir/somefile.go match //! ``` //! //! ## Automatic OPTIONS responses and CORS //! //! One might wish to modify automatic responses to OPTIONS requests, e.g. to support [CORS preflight requests](https://developer.mozilla.org/en-US/docs/Glossary/preflight_request) or to set other headers. This can be achieved using the [`Router::global_options`](https://docs.rs/httprouter/newest/httprouter/router/struct.Router.html#method.global_options) handler: //! //! ```rust //! use httprouter::{Router}; //! use hyper::{Request, Response, Body, Error}; //! //! async fn cors(_: Request<Body>) -> Result<Response<Body>, Error> { //! let res = Response::builder() //! .header("Access-Control-Allow-Methods", "Allow") //! .header("Access-Control-Allow-Origin", "*") //! .body(Body::empty()) //! .unwrap(); //! Ok(res) //! } //! //! fn main() { //! let router = Router::default().global_options(cors); //! } //! ``` //! //! ### Multi-domain / Sub-domains //! //! Here is a quick example: Does your server serve multiple domains / hosts? You want to use sub-domains? Define a router per host! //! //! ```rust,no_run //! use httprouter::Router; //! use hyper::service::{make_service_fn, service_fn}; //! # use hyper::{Body, Request, Response}; //! # use std::collections::HashMap; //! # use std::convert::Infallible; //! # use std::sync::Arc; //! //! pub struct HostSwitch<'a>(HashMap<String, Router<'a>>); //! //! impl HostSwitch<'_> { //! async fn serve(&self, req: Request<Body>) -> hyper::Result<Response<Body>> { //! # let forbidden = || Response::builder() //! # .status(401) //! # .body(Body::empty()) //! # .unwrap(); //! match req.headers().get("host") { //! Some(host) => match self.0.get(host.to_str().unwrap()) { //! Some(router) => router.serve(req).await, //! None => Ok(forbidden()), //! }, //! None => Ok(forbidden()), //! } //! } //! } //! //! #[tokio::main] //! async fn main() { //! let mut host_switch = HostSwitch(HashMap::new()); //! host_switch.0.insert("example.com:12345".into(), Router::default()); //! //! let host_switch = Arc::new(host_switch); //! //! let make_svc = make_service_fn(move |_| { //! let host_switch = host_switch.clone(); //! async move { //! Ok::<_, Infallible>(service_fn(move |req| { //! let host_switch = host_switch.clone(); //! async move { host_switch.serve(req).await } //! })) //! } //! }); //! //! hyper::Server::bind(&([127, 0, 0, 1], 3000).into()) //! .serve(make_svc) //! .await; //! } //! ``` //! //! ### Not Found Handler //! //! **NOTE: It might be required to set [`Router::method_not_allowed`](https://docs.rs/httprouter/newest/httprouter/router/struct.Router.html#structfield.method_not_allowed) to `None` to avoid problems.** //! //! You can use another handler, to handle requests which could not be matched by this router by using the [`Router::not_found`](https://docs.rs/httprouter/newest/httprouter/router/struct.Router.html#structfield.not_found) handler. //! //! The `not_found` handler can for example be used to return a 404 page: //! //! ```rust //! use httprouter::Router; //! use hyper::{Request, Response, Body, Error}; //! //! async fn not_found(req: Request<Body>) -> Result<Response<Body>, Error> { //! let res = Response::builder() //! .status(404) //! .body(Body::empty()) //! .unwrap(); //! Ok(res) //! } //! //! fn main() { //! let router = Router::default().not_found(not_found); //! } //! ``` //! //! ### Static files //! //! You can use the router to serve pages from a static file directory: //! //! ```rust //! // TODO //! ``` #![forbid(unsafe_code)] pub(crate) mod path; #[doc(hidden)] pub mod router; #[doc(inline)] pub use router::{Handler, Router}; #[doc(inline)] pub use matchit::Params; // test the code examples in README.md #[cfg(doctest)] mod test_readme { macro_rules! doc_comment { ($x:expr) => { #[doc = $x] extern "C" {} }; } doc_comment!(include_str!("../README.md")); }