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
//! Actix web is a small, pragmatic, and extremely fast web framework //! for Rust. //! //! ```rust //! use actix_web::{web, App, Responder, HttpServer}; //! # use std::thread; //! //! fn index(info: web::Path<(String, u32)>) -> impl Responder { //! format!("Hello {}! id:{}", info.0, info.1) //! } //! //! fn main() -> std::io::Result<()> { //! # thread::spawn(|| { //! HttpServer::new(|| App::new().service( //! web::resource("/{name}/{id}/index.html").to(index)) //! ) //! .bind("127.0.0.1:8080")? //! .run() //! # }); //! # Ok(()) //! } //! ``` //! //! ## Documentation & community resources //! //! Besides the API documentation (which you are currently looking //! at!), several other resources are available: //! //! * [User Guide](https://actix.rs/docs/) //! * [Chat on gitter](https://gitter.im/actix/actix) //! * [GitHub repository](https://github.com/actix/actix-web) //! * [Cargo package](https://crates.io/crates/actix-web) //! //! To get started navigating the API documentation you may want to //! consider looking at the following pages: //! //! * [App](struct.App.html): This struct represents an actix-web //! application and is used to configure routes and other common //! settings. //! //! * [HttpServer](struct.HttpServer.html): This struct //! represents an HTTP server instance and is used to instantiate and //! configure servers. //! //! * [HttpRequest](struct.HttpRequest.html) and //! [HttpResponse](struct.HttpResponse.html): These structs //! represent HTTP requests and responses and expose various methods //! for inspecting, creating and otherwise utilizing them. //! //! ## Features //! //! * Supported *HTTP/1.x* and *HTTP/2.0* protocols //! * Streaming and pipelining //! * Keep-alive and slow requests handling //! * `WebSockets` server/client //! * Transparent content compression/decompression (br, gzip, deflate) //! * Configurable request routing //! * Multipart streams //! * SSL support with OpenSSL or `native-tls` //! * Middlewares (`Logger`, `Session`, `CORS`, `CSRF`, `DefaultHeaders`) //! * Supports [Actix actor framework](https://github.com/actix/actix) //! * Supported Rust version: 1.32 or later //! //! ## Package feature //! //! * `client` - enables http client //! * `tls` - enables ssl support via `native-tls` crate //! * `ssl` - enables ssl support via `openssl` crate, supports `http/2` //! * `rust-tls` - enables ssl support via `rustls` crate, supports `http/2` //! * `cookies` - enables cookies support, includes `ring` crate as //! dependency //! * `brotli` - enables `brotli` compression support, requires `c` //! compiler //! * `flate2-zlib` - enables `gzip`, `deflate` compression support, requires //! `c` compiler //! * `flate2-rust` - experimental rust based implementation for //! `gzip`, `deflate` compression. //! #![allow(clippy::type_complexity, clippy::new_without_default)] mod app; mod app_service; mod config; mod data; pub mod error; mod extract; pub mod guard; mod handler; mod info; pub mod middleware; mod request; mod resource; mod responder; mod rmap; mod route; mod scope; mod server; mod service; pub mod test; mod types; #[allow(unused_imports)] #[macro_use] extern crate actix_web_codegen; #[doc(hidden)] pub use actix_web_codegen::*; // re-export for convenience pub use actix_http::Response as HttpResponse; pub use actix_http::{cookie, http, Error, HttpMessage, ResponseError, Result}; pub use crate::app::App; pub use crate::extract::FromRequest; pub use crate::request::HttpRequest; pub use crate::resource::Resource; pub use crate::responder::{Either, Responder}; pub use crate::route::Route; pub use crate::scope::Scope; pub use crate::server::HttpServer; pub mod dev { //! The `actix-web` prelude for library developers //! //! The purpose of this module is to alleviate imports of many common actix //! traits by adding a glob import to the top of actix heavy modules: //! //! ``` //! # #![allow(unused_imports)] //! use actix_web::dev::*; //! ``` pub use crate::app::AppRouter; pub use crate::config::{AppConfig, ServiceConfig}; pub use crate::info::ConnectionInfo; pub use crate::rmap::ResourceMap; pub use crate::service::{ HttpServiceFactory, ServiceFromRequest, ServiceRequest, ServiceResponse, }; pub use crate::types::form::UrlEncoded; pub use crate::types::json::JsonBody; pub use crate::types::payload::HttpMessageBody; pub use crate::types::readlines::Readlines; pub use actix_http::body::{Body, BodySize, MessageBody, ResponseBody}; pub use actix_http::ResponseBuilder as HttpResponseBuilder; pub use actix_http::{ Extensions, Payload, PayloadStream, RequestHead, ResponseHead, }; pub use actix_router::{Path, ResourceDef, ResourcePath, Url}; pub use actix_server::Server; pub(crate) fn insert_slash(path: &str) -> String { let mut path = path.to_owned(); if !path.is_empty() && !path.starts_with('/') { path.insert(0, '/'); }; path } } pub mod web { //! Various types use actix_http::{http::Method, Response}; use actix_service::{fn_transform, Service, Transform}; 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; use crate::service::{ServiceRequest, ServiceResponse}; 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, http, 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<P: 'static>(path: &str) -> Resource<P> { 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 /// # extern crate actix_web; /// use actix_web::{web, App, HttpRequest, 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<P: 'static>(path: &str) -> Scope<P> { Scope::new(path) } /// Create *route* without configuration. pub fn route<P: 'static>() -> Route<P> { Route::new() } /// Create *route* with `GET` method guard. pub fn get<P: 'static>() -> Route<P> { Route::new().method(Method::GET) } /// Create *route* with `POST` method guard. pub fn post<P: 'static>() -> Route<P> { Route::new().method(Method::POST) } /// Create *route* with `PUT` method guard. pub fn put<P: 'static>() -> Route<P> { Route::new().method(Method::PUT) } /// Create *route* with `PATCH` method guard. pub fn patch<P: 'static>() -> Route<P> { Route::new().method(Method::PATCH) } /// Create *route* with `DELETE` method guard. pub fn delete<P: 'static>() -> Route<P> { Route::new().method(Method::DELETE) } /// Create *route* with `HEAD` method guard. pub fn head<P: 'static>() -> Route<P> { Route::new().method(Method::HEAD) } /// Create *route* and add method guard. pub fn method<P: 'static>(method: Method) -> Route<P> { 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, P: 'static>(handler: F) -> Route<P> where F: Factory<I, R> + 'static, I: FromRequest<P> + 'static, R: Responder + 'static, { Route::new().to(handler) } /// Create a new route and add async handler. /// /// ```rust /// use actix_web::{web, App, HttpResponse, Error}; /// /// fn index() -> impl futures::Future<Item=HttpResponse, Error=Error> { /// futures::future::ok(HttpResponse::Ok().finish()) /// } /// /// App::new().service(web::resource("/").route( /// web::to_async(index)) /// ); /// ``` pub fn to_async<F, I, R, P: 'static>(handler: F) -> Route<P> where F: AsyncFactory<I, R>, I: FromRequest<P> + '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() } /// Create middleare pub fn md<F, R, S, P, B>( f: F, ) -> impl Transform< S, Request = ServiceRequest<P>, Response = ServiceResponse<B>, Error = Error, InitError = (), > where S: Service< Request = ServiceRequest<P>, Response = ServiceResponse<B>, Error = Error, >, F: FnMut(ServiceRequest<P>, &mut S) -> R + Clone, R: IntoFuture<Item = ServiceResponse<B>, Error = Error>, { fn_transform(f) } } #[cfg(feature = "client")] pub mod client { //! An HTTP Client //! //! ```rust //! # use futures::future::{Future, lazy}; //! use actix_rt::System; //! use actix_web::client::Client; //! //! fn main() { //! System::new("test").block_on(lazy(|| { //! let mut client = Client::default(); //! //! client.get("http://www.rust-lang.org") // <- Create request builder //! .header("User-Agent", "Actix-web") //! .send() // <- Send http request //! .map_err(|_| ()) //! .and_then(|response| { // <- server http response //! println!("Response: {:?}", response); //! Ok(()) //! }) //! })); //! } //! ``` pub use awc::error::{ ConnectError, InvalidUrl, PayloadError, SendRequestError, WsClientError, }; pub use awc::{test, Client, ClientBuilder, ClientRequest, ClientResponse}; }