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 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
//! # Treemux //! //! [](https://docs.rs/treemux/0.3.0) //! [](https://crates.io/crates/treemux) //! [](https://crates.io/crates/treemux) //! [](https://github.com/casualjim/rs-treemux/actions) //! //! Treemux 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. //! //! ## 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? Treemux 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:** Treemux 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. //! //! Of course you can also set **custom [`NotFound`](https://docs.rs/treemux/newest/treemux/router/struct.Router.html#structfield.not_found) and [`MethodNotAllowed`](https://docs.rs/treemux/newest/treemux/router/struct.Router.html#structfield.method_not_allowed) handlers** , [**serve static files**](https://docs.rs/treemux/newest/treemux/router/struct.Router.html#method.serve_files), and [**automatically respond to OPTIONS requests**](https://docs.rs/treemux/newest/treemux/router/struct.Router.html#structfield.global_options) //! //! ## Usage //! //! Here is a simple example: //! //! ```rust,no_run //! use treemux::{Treemux, RouterBuilder, Params, Handler}; //! use std::convert::Infallible; //! use hyper::{Request, Response, Body}; //! use hyper::http::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 mut router = Treemux::builder(); //! router.get("/", index); //! router.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: //! //! ```ignore //! 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: //! //! ```ignore //! 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/treemux/newest/treemux/router/struct.Router.html#structfield.global_options) handler: //! //! ```rust //! use treemux::{Treemux, Handler}; //! use hyper::{Request, Response, Body}; //! use hyper::http::Error; //! //! async fn global_options(_: Request<Body>) -> Result<Response<Body>, Error> { //! Ok(Response::builder() //! .header("Access-Control-Allow-Methods", "Allow") //! .header("Access-Control-Allow-Origin", "*") //! .body(Body::empty()) //! .unwrap()) //! } //! //! fn main() { //! let mut router = Treemux::builder(); //! router.global_options(global_options); //! } //! ``` //! //! ### 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 treemux::{Handler, Treemux, RouterBuilder}; //! use hyper::service::{make_service_fn, service_fn}; //! use hyper::{Body, Request, Response, Server, StatusCode}; //! use std::collections::HashMap; //! use std::convert::Infallible; //! use std::sync::Arc; //! //! pub struct HostSwitch(HashMap<String, Treemux>); //! //! impl HostSwitch { //! async fn serve(&self, req: Request<Body>) -> Result<Response<Body>, hyper::http::Error> { //! let forbidden = Response::builder() //! .status(StatusCode::FORBIDDEN) //! .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), //! } //! } //! } //! //! async fn hello(_: Request<Body>) -> Result<Response<Body>, hyper::http::Error> { //! Ok(Response::new(Body::default())) //! } //! //! #[tokio::main] //! async fn main() { //! let mut router = Treemux::builder(); //! router.get("/", hello); //! //! let mut host_switch: HostSwitch = HostSwitch(HashMap::new()); //! host_switch.0.insert("example.com:12345".into(), router.into()); //! //! 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: Request<Body>| { //! let host_switch = host_switch.clone(); //! async move { host_switch.serve(req).await } //! })) //! } //! }); //! //! let server = 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/treemux/newest/treemux/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/treemux/newest/treemux/router/struct.Router.html#structfield.not_found) handler. //! //! The `not_found` handler can for example be used to return a 404 page: //! //! ```rust //! use treemux::{Treemux, Handler, RouterBuilder}; //! use hyper::{Request, Response, Body}; //! //! let mut router = Treemux::builder(); //! router.not_found(|_| async { //! Ok(Response::builder() //! .status(400) //! .body(Body::empty()) //! .unwrap()) //! }); //! ``` //! //! ### Static files //! //! You can use the router to serve pages from a static file directory: //! //! ```rust //! // TODO //! ``` #[macro_use] extern crate kv_log_macro; pub mod middlewares; pub(crate) mod path; mod serve; mod tree; use std::fmt::Display; pub use tree::{Param, Params}; #[doc(hidden)] pub mod router; #[doc(inline)] pub use router::*; /// Sets the behavior when the router redirects the request to the /// canonical version of the requested URL using `redirect_trailing_slash` or `redirect_clean`. /// The default behavior is to return a 301 status, redirecting the browser to the version /// of the URL that matches the given pattern. /// /// On a POST request, most browsers that receive a 301 will submit a GET request to /// the redirected URL, meaning that any data will likely be lost. If you want to handle /// and avoid this behavior, you may use `TEMPORARY_REDIRECT` (307), which causes most browsers to /// resubmit the request using the original method and request body. /// /// Since 307 is supposed to be a temporary redirect, the new 308 status code has been /// proposed, which is treated the same, except it indicates correctly that the redirection /// is permanent. The big caveat here is that the RFC is relatively recent, and older /// browsers will not know what to do with it. Therefore its use is not recommended /// unless you really know what you're doing. #[derive(Debug, Clone, Copy, PartialEq, Eq)] pub enum RedirectBehavior { Redirect301, Redirect307, Redirect308, UseHandler, } impl Display for RedirectBehavior { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { write!(f, "{:?}", self) } } // // test the code examples in README.md #[cfg(doctest)] mod test_readme { macro_rules! doc_comment { ($x:expr) => { #[doc = $x] extern {} }; } doc_comment!(include_str!("../README.md")); }