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 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
//! [`Router`](crate::Router) 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 better. //! //! 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. //! //! With the `hyper-server` feature enabled, the `Router` can be used as a router for a hyper server: //! //! ```rust,no_run //! use httprouter::{Router, Params}; //! use std::convert::Infallible; //! 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; //! } //!``` //! //! The registered path, against which the router matches incoming requests, can //! contain two types of parameters: //! ```ignore //! Syntax Type //! :name named parameter //! *name catch-all parameter //! ``` //! //! Named parameters are dynamic path segments. They match anything until the //! next '/' or the path end: //! ```ignore //! Path: /blog/:category/:post //! ``` //! //! Requests: //! ```ignore //! /blog/rust/request-routers match: category="rust", post="request-routers" //! /blog/rust/request-routers/ no match, but the router would redirect //! /blog/rust/ no match //! /blog/rust/request-routers/comments no match //! ``` //! //! Catch-all parameters match anything until the path end, including the //! directory index (the '/' before the catch-all). Since they match anything //! until the end, catch-all parameters must always be the final path element. //! Path: /files/*filepath //! //! Requests: //! ```ignore //! /files/ match: filepath="/" //! /files/LICENSE match: filepath="/LICENSE" //! /files/templates/article.html match: filepath="/templates/article.html" //! /files no match, but the router would redirect //! ``` //! The value of parameters is saved as a `Vec` of the `Param` struct, consisting //! each of a key and a value. //! //! There are two ways to retrieve the value of a parameter: //! 1) by the name of the parameter //! ```ignore //! # use httprouter::tree::Params; //! # let params = Params::default(); //! let user = params.get("user") // defined by :user or *user //! ``` //! 2) by the index of the parameter. This way you can also get the name (key) //! ```rust,no_run //! # use httprouter::Params; //! # let params = Params::default(); //! let third_key = ¶ms[2].key; // the name of the 3rd parameter //! let third_value = ¶ms[2].value; // the value of the 3rd parameter //! ``` use crate::path::clean; use hyper::service::Service; use hyper::{header, Body, Method, Request, Response, StatusCode}; use matchit::{Match, Node}; use std::collections::HashMap; use std::future::Future; use std::pin::Pin; use std::str; use std::sync::Arc; use std::task::{Context, Poll}; /// Router dispatches requests to different handlers via configurable routes. pub struct Router<'path> { trees: HashMap<Method, Node<'path, Box<dyn Handler>>>, redirect_trailing_slash: bool, redirect_fixed_path: bool, handle_method_not_allowed: bool, handle_options: bool, global_options: Option<Box<dyn Handler>>, not_found: Option<Box<dyn Handler>>, method_not_allowed: Option<Box<dyn Handler>>, } impl<'path> Router<'path> { /// Insert a value into the router for a specific path indexed by a key. /// ```rust /// use httprouter::Router; /// use hyper::{Response, Body, Method}; /// /// let router = Router::default() /// .handle("/teapot", Method::GET, |_| async { /// Ok(Response::new(Body::from("I am a teapot!"))) /// }); /// ``` pub fn handle( mut self, path: &'path str, method: Method, handler: impl Handler + 'static, ) -> Self { if !path.starts_with('/') { panic!("path must begin with '/' in path '{}'", path); } self.trees .entry(method) .or_insert_with(Node::default) .insert(path, Box::new(handler)); self } /// Lookup allows the manual lookup of handler for a specific method and path. /// If the handler is not found, it returns a `Err(bool)` indicating whether a redirection should be performed to the same path with a trailing slash /// ```rust /// use httprouter::Router; /// use hyper::{Response, Body, Method}; /// /// let router = Router::default() /// .get("/home", |_| async { /// Ok(Response::new(Body::from("Welcome!"))) /// }); /// /// let res = router.lookup(&Method::GET, "/home").unwrap(); /// assert!(res.params.is_empty()); /// ``` pub fn lookup( &self, method: &Method, path: &str, ) -> Result<Match<'_, Box<dyn Handler>>, matchit::Tsr> { self.trees .get(method) .map_or(Err(matchit::Tsr::No), |n| n.at(path)) } /// TODO pub fn serve_files() { unimplemented!() } /// Register a handler for `GET` requests pub fn get(self, path: &'path str, handler: impl Handler + 'static) -> Self { self.handle(path, Method::GET, handler) } /// Register a handler for `HEAD` requests pub fn head(self, path: &'path str, handler: impl Handler + 'static) -> Self { self.handle(path, Method::HEAD, handler) } /// Register a handler for `OPTIONS` requests pub fn options(self, path: &'path str, handler: impl Handler + 'static) -> Self { self.handle(path, Method::OPTIONS, handler) } /// Register a handler for `POST` requests pub fn post(self, path: &'path str, handler: impl Handler + 'static) -> Self { self.handle(path, Method::POST, handler) } /// Register a handler for `PUT` requests pub fn put(self, path: &'path str, handler: impl Handler + 'static) -> Self { self.handle(path, Method::PUT, handler) } /// Register a handler for `PATCH` requests pub fn patch(self, path: &'path str, handler: impl Handler + 'static) -> Self { self.handle(path, Method::PATCH, handler) } /// Register a handler for `DELETE` requests pub fn delete(self, path: &'path str, handler: impl Handler + 'static) -> Self { self.handle(path, Method::DELETE, handler) } /// Enables automatic redirection if the current route can't be matched but a /// handler for the path with (without) the trailing slash exists. /// For example if `/foo/` is requested but a route only exists for `/foo`, the /// client is redirected to `/foo` with HTTP status code 301 for `GET` requests /// and 307 for all other request methods. pub fn redirect_trailing_slash(mut self) -> Self { self.redirect_trailing_slash = true; self } /// If enabled, the router tries to fix the current request path, if no /// handle is registered for it. /// First superfluous path elements like `../` or `//` are removed. /// Afterwards the router does a case-insensitive lookup of the cleaned path. /// If a handle can be found for this route, the router makes a redirection /// to the corrected path with status code 301 for `GET` requests and 307 for /// all other request methods. /// For example `/FOO` and `/..//Foo` could be redirected to `/foo`. /// `redirect_trailing_slash` is independent of this option. pub fn redirect_fixed_path(mut self) -> Self { self.redirect_fixed_path = true; self } /// If enabled, the router checks if another method is allowed for the /// current route, if the current request can not be routed. /// If this is the case, the request is answered with `MethodNotAllowed` /// and HTTP status code 405. /// If no other Method is allowed, the request is delegated to the `NotFound` /// handler. pub fn handle_method_not_allowed(mut self) -> Self { self.handle_method_not_allowed = true; self } /// If enabled, the router automatically replies to `OPTIONS` requests. /// Custom `OPTIONS` handlers take priority over automatic replies. pub fn handle_options(mut self) -> Self { self.handle_options = true; self } /// An optional handler that is called on automatic `OPTIONS` requests. /// The handler is only called if `handle_options` is true and no `OPTIONS` /// handler for the specific path was set. /// The `Allowed` header is set before calling the handler. pub fn global_options(mut self, handler: impl Handler + 'static) -> Self { self.global_options = Some(Box::new(handler)); self } /// Configurable handler which is called when no matching route is /// found. pub fn not_found(mut self, handler: impl Handler + 'static) -> Self { self.not_found = Some(Box::new(handler)); self } /// A configurable handler which is called when a request /// cannot be routed and `handle_method_not_allowed` is true. /// The `Allow` header with allowed request methods is set before the handler /// is called. pub fn method_not_allowed(mut self, handler: impl Handler + 'static) -> Self { self.method_not_allowed = Some(Box::new(handler)); self } /// Returns a list of the allowed methods for a specific path /// ```rust /// use httprouter::Router; /// use hyper::{Response, Body, Method}; /// /// let router = Router::default() /// .get("/home", |_| async { /// Ok(Response::new(Body::from("Welcome!"))) /// }); /// /// let allowed = router.allowed("/home"); /// assert!(allowed.contains(&"GET".to_string())); /// ``` pub fn allowed(&self, path: &str) -> Vec<String> { let mut allowed: Vec<String> = Vec::new(); match path { "*" => { for method in self.trees.keys() { if method != Method::OPTIONS { allowed.push(method.to_string()); } } } _ => { for method in self.trees.keys() { if method == Method::OPTIONS { continue; } if let Some(tree) = self.trees.get(method) { let handler = tree.at(path); if handler.is_ok() { allowed.push(method.to_string()); } }; } } }; if !allowed.is_empty() { allowed.push(Method::OPTIONS.to_string()) } allowed } } /// The default httprouter configuration impl Default for Router<'_> { fn default() -> Self { Self { trees: HashMap::new(), redirect_trailing_slash: true, redirect_fixed_path: true, handle_method_not_allowed: true, handle_options: true, global_options: None, method_not_allowed: None, not_found: Some(Box::new(|_| async { Ok(Response::builder() .status(400) .body(Body::from("404: Not Found")) .unwrap()) })), } } } /// Represents a HTTP handler function. /// This trait is implemented for asynchronous functions that take a `Request` and return a /// `Result<Response<Body>, hyper::Error>` /// ```rust /// # use httprouter::Handler; /// # use hyper::{Request, Response, Body}; /// async fn hello(_: Request<Body>) -> Result<Response<Body>, hyper::Error> { /// Ok(Response::new(Body::empty())) /// } /// /// let handler: Box<dyn Handler> = Box::new(hello); /// ``` pub trait Handler: Send + Sync { fn handle( &self, req: Request<Body>, ) -> Pin<Box<dyn Future<Output = hyper::Result<Response<Body>>> + Send + Sync>>; } impl<F, R> Handler for F where F: Fn(Request<Body>) -> R + Send + Sync, R: Future<Output = Result<Response<Body>, hyper::Error>> + Send + Sync + 'static, { fn handle( &self, req: Request<Body>, ) -> Pin<Box<dyn Future<Output = hyper::Result<Response<Body>>> + Send + Sync>> { Box::pin(self(req)) } } #[doc(hidden)] pub struct MakeRouterService<'path>(RouterService<'path>); impl<'path, T> Service<T> for MakeRouterService<'path> { type Response = RouterService<'path>; type Error = hyper::Error; type Future = futures_util::future::Ready<Result<Self::Response, Self::Error>>; fn poll_ready(&mut self, _: &mut Context<'_>) -> Poll<Result<(), Self::Error>> { Poll::Ready(Ok(())) } fn call(&mut self, _: T) -> Self::Future { let service = self.0.clone(); futures_util::future::ok(service) } } #[derive(Clone)] #[doc(hidden)] pub struct RouterService<'path>(Arc<Router<'path>>); impl<'path> RouterService<'path> { fn new(router: Router<'path>) -> Self { RouterService(Arc::new(router)) } } impl<'path> Service<Request<Body>> for RouterService<'path> { type Response = Response<Body>; type Error = hyper::Error; type Future = Pin<Box<dyn Future<Output = hyper::Result<Response<Body>>> + Send + Sync>>; fn poll_ready(&mut self, _: &mut Context<'_>) -> Poll<Result<(), Self::Error>> { Poll::Ready(Ok(())) } fn call(&mut self, req: Request<Body>) -> Self::Future { self.0.serve(req) } } impl<'path> Router<'path> { /// Converts the `Router` into a `Service` which you can serve directly with `Hyper`. /// If you have an existing `Service` that you want to incorporate a `Router` into, see /// [`Router::serve`](crate::Router::serve). /// ```rust,no_run /// # use httprouter::Router; /// # use std::convert::Infallible; /// # async fn run() -> Result<(), Box<dyn std::error::Error>> { /// // Our router... /// let router = Router::default(); /// /// // Convert it into a service... /// let service = router.into_service(); /// /// // Serve with hyper /// hyper::Server::bind(&([127, 0, 0, 1], 3030).into()) /// .serve(service) /// .await?; /// # Ok(()) /// # } /// ``` pub fn into_service(self) -> MakeRouterService<'path> { MakeRouterService(RouterService::new(self)) } /// An asynchronous function from a `Request` to a `Response`. You will generally not need to use /// this function directly, and instead use /// [`Router::into_service`](crate::Router::into_service). However, it may be useful when /// incorporating the router into a larger service. /// ```rust,no_run /// # use httprouter::Router; /// # use hyper::service::{make_service_fn, service_fn}; /// # use hyper::{Request, Body, Server}; /// # use std::convert::Infallible; /// # use std::sync::Arc; /// /// # async fn run() { /// let router = Arc::new(Router::default()); /// /// let make_svc = make_service_fn(move |_| { /// let router = router.clone(); /// async move { /// Ok::<_, Infallible>(service_fn(move |req: Request<Body>| { /// let router = router.clone(); /// async move { router.serve(req).await } /// })) /// } /// }); /// /// let server = Server::bind(&([127, 0, 0, 1], 3000).into()) /// .serve(make_svc) /// .await; /// # } /// ``` pub fn serve( &self, mut req: Request<Body>, ) -> Pin<Box<dyn Future<Output = hyper::Result<Response<Body>>> + Send + Sync>> { let root = self.trees.get(req.method()); let path = req.uri().path(); if let Some(root) = root { match root.at(path) { Ok(lookup) => { req.extensions_mut().insert(lookup.params); return lookup.value.handle(req); } Err(tsr) => { if req.method() != Method::CONNECT && path != "/" { let code = match *req.method() { // Moved Permanently, request with GET method Method::GET => StatusCode::MOVED_PERMANENTLY, // Permanent Redirect, request with same method _ => StatusCode::PERMANENT_REDIRECT, }; if tsr == matchit::Tsr::Yes && self.redirect_trailing_slash { let path = if path.len() > 1 && path.ends_with('/') { path[..path.len() - 1].to_string() } else { path.to_string() + "/" }; return Box::pin(async move { Ok(Response::builder() .header(header::LOCATION, path.as_str()) .status(code) .body(Body::empty()) .unwrap()) }); }; if self.redirect_fixed_path { if let Some(fixed_path) = root.path_ignore_case(&clean(path), self.redirect_trailing_slash) { return Box::pin(async move { Ok(Response::builder() .header(header::LOCATION, fixed_path.as_str()) .status(code) .body(Body::empty()) .unwrap()) }); } }; }; } } }; if req.method() == Method::OPTIONS && self.handle_options { let allow = self.allowed(path).join(", "); if allow != "" { match &self.global_options { Some(handler) => return handler.handle(req), None => { return Box::pin(async { Ok(Response::builder() .header(header::ALLOW, allow) .body(Body::empty()) .unwrap()) }); } }; } } else if self.handle_method_not_allowed { let allow = self.allowed(path).join(", "); if !allow.is_empty() { if let Some(ref handler) = self.method_not_allowed { return handler.handle(req); } return Box::pin(async { Ok(Response::builder() .header(header::ALLOW, allow) .status(StatusCode::METHOD_NOT_ALLOWED) .body(Body::empty()) .unwrap()) }); } }; match &self.not_found { Some(handler) => handler.handle(req), None => { Box::pin(async { Ok(Response::builder().status(404).body(Body::empty()).unwrap()) }) } } } }