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
//! Essentials helper functions and types for application registration. use actix_http::{http::Method, Response}; use futures::{Future, IntoFuture}; pub use actix_http::Response as HttpResponse; pub use bytes::{Bytes, BytesMut}; use crate::error::{BlockingError, Error}; use crate::extract::FromRequest; use crate::handler::{AsyncFactory, Factory}; use crate::resource::Resource; use crate::responder::Responder; use crate::route::Route; use crate::scope::Scope; pub use crate::config::RouterConfig; pub use crate::data::{Data, RouteData}; pub use crate::request::HttpRequest; pub use crate::types::*; /// Create resource for a specific path. /// /// Resources may have variable path segments. For example, a /// resource with the path `/a/{name}/c` would match all incoming /// requests with paths such as `/a/b/c`, `/a/1/c`, or `/a/etc/c`. /// /// A variable segment is specified in the form `{identifier}`, /// where the identifier can be used later in a request handler to /// access the matched value for that segment. This is done by /// looking up the identifier in the `Params` object returned by /// `HttpRequest.match_info()` method. /// /// By default, each segment matches the regular expression `[^{}/]+`. /// /// You can also specify a custom regex in the form `{identifier:regex}`: /// /// For instance, to route `GET`-requests on any route matching /// `/users/{userid}/{friend}` and store `userid` and `friend` in /// the exposed `Params` object: /// /// ```rust /// # extern crate actix_web; /// use actix_web::{web, App, HttpResponse}; /// /// fn main() { /// let app = App::new().service( /// web::resource("/users/{userid}/{friend}") /// .route(web::get().to(|| HttpResponse::Ok())) /// .route(web::head().to(|| HttpResponse::MethodNotAllowed())) /// ); /// } /// ``` pub fn resource(path: &str) -> Resource { Resource::new(path) } /// Configure scope for common root path. /// /// Scopes collect multiple paths under a common path prefix. /// Scope path can contain variable path segments as resources. /// /// ```rust /// use actix_web::{web, App, HttpResponse}; /// /// fn main() { /// let app = App::new().service( /// web::scope("/{project_id}") /// .service(web::resource("/path1").to(|| HttpResponse::Ok())) /// .service(web::resource("/path2").to(|| HttpResponse::Ok())) /// .service(web::resource("/path3").to(|| HttpResponse::MethodNotAllowed())) /// ); /// } /// ``` /// /// In the above example, three routes get added: /// * /{project_id}/path1 /// * /{project_id}/path2 /// * /{project_id}/path3 /// pub fn scope(path: &str) -> Scope { Scope::new(path) } /// Create *route* without configuration. pub fn route() -> Route { Route::new() } /// Create *route* with `GET` method guard. /// /// ```rust /// use actix_web::{web, App, HttpResponse}; /// /// fn main() { /// let app = App::new().service( /// web::resource("/{project_id}") /// .route(web::get().to(|| HttpResponse::Ok())) /// ); /// } /// ``` /// /// In the above example, one `GET` route get added: /// * /{project_id} /// pub fn get() -> Route { Route::new().method(Method::GET) } /// Create *route* with `POST` method guard. /// /// ```rust /// use actix_web::{web, App, HttpResponse}; /// /// fn main() { /// let app = App::new().service( /// web::resource("/{project_id}") /// .route(web::post().to(|| HttpResponse::Ok())) /// ); /// } /// ``` /// /// In the above example, one `POST` route get added: /// * /{project_id} /// pub fn post() -> Route { Route::new().method(Method::POST) } /// Create *route* with `PUT` method guard. /// /// ```rust /// use actix_web::{web, App, HttpResponse}; /// /// fn main() { /// let app = App::new().service( /// web::resource("/{project_id}") /// .route(web::put().to(|| HttpResponse::Ok())) /// ); /// } /// ``` /// /// In the above example, one `PUT` route get added: /// * /{project_id} /// pub fn put() -> Route { Route::new().method(Method::PUT) } /// Create *route* with `PATCH` method guard. /// /// ```rust /// use actix_web::{web, App, HttpResponse}; /// /// fn main() { /// let app = App::new().service( /// web::resource("/{project_id}") /// .route(web::patch().to(|| HttpResponse::Ok())) /// ); /// } /// ``` /// /// In the above example, one `PATCH` route get added: /// * /{project_id} /// pub fn patch() -> Route { Route::new().method(Method::PATCH) } /// Create *route* with `DELETE` method guard. /// /// ```rust /// use actix_web::{web, App, HttpResponse}; /// /// fn main() { /// let app = App::new().service( /// web::resource("/{project_id}") /// .route(web::delete().to(|| HttpResponse::Ok())) /// ); /// } /// ``` /// /// In the above example, one `DELETE` route get added: /// * /{project_id} /// pub fn delete() -> Route { Route::new().method(Method::DELETE) } /// Create *route* with `HEAD` method guard. /// /// ```rust /// use actix_web::{web, App, HttpResponse}; /// /// fn main() { /// let app = App::new().service( /// web::resource("/{project_id}") /// .route(web::head().to(|| HttpResponse::Ok())) /// ); /// } /// ``` /// /// In the above example, one `HEAD` route get added: /// * /{project_id} /// pub fn head() -> Route { Route::new().method(Method::HEAD) } /// Create *route* and add method guard. /// /// ```rust /// use actix_web::{web, http, App, HttpResponse}; /// /// fn main() { /// let app = App::new().service( /// web::resource("/{project_id}") /// .route(web::method(http::Method::GET).to(|| HttpResponse::Ok())) /// ); /// } /// ``` /// /// In the above example, one `GET` route get added: /// * /{project_id} /// pub fn method(method: Method) -> Route { Route::new().method(method) } /// Create a new route and add handler. /// /// ```rust /// use actix_web::{web, App, HttpResponse}; /// /// fn index() -> HttpResponse { /// unimplemented!() /// } /// /// App::new().service( /// web::resource("/").route( /// web::to(index)) /// ); /// ``` pub fn to<F, I, R>(handler: F) -> Route where F: Factory<I, R> + 'static, I: FromRequest + 'static, R: Responder + 'static, { Route::new().to(handler) } /// Create a new route and add async handler. /// /// ```rust /// # use futures::future::{ok, Future}; /// use actix_web::{web, App, HttpResponse, Error}; /// /// fn index() -> impl Future<Item=HttpResponse, Error=Error> { /// ok(HttpResponse::Ok().finish()) /// } /// /// App::new().service(web::resource("/").route( /// web::to_async(index)) /// ); /// ``` pub fn to_async<F, I, R>(handler: F) -> Route where F: AsyncFactory<I, R>, I: FromRequest + 'static, R: IntoFuture + 'static, R::Item: Into<Response>, R::Error: Into<Error>, { Route::new().to_async(handler) } /// Execute blocking function on a thread pool, returns future that resolves /// to result of the function execution. pub fn block<F, I, E>(f: F) -> impl Future<Item = I, Error = BlockingError<E>> where F: FnOnce() -> Result<I, E> + Send + 'static, I: Send + 'static, E: Send + std::fmt::Debug + 'static, { actix_threadpool::run(f).from_err() }