//! 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 //! //! * `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-c` - 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::{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, BodyLength, MessageBody, ResponseBody}; pub use actix_http::ResponseBuilder as HttpResponseBuilder; pub use actix_http::{ Extensions, Head, 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_rt::blocking; 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::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(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 /// # 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(path: &str) -> Scope

{ Scope::new(path) } /// Create *route* without configuration. pub fn route() -> Route

{ Route::new() } /// Create *route* with `GET` method guard. pub fn get() -> Route

{ Route::new().method(Method::GET) } /// Create *route* with `POST` method guard. pub fn post() -> Route

{ Route::new().method(Method::POST) } /// Create *route* with `PUT` method guard. pub fn put() -> Route

{ Route::new().method(Method::PUT) } /// Create *route* with `PATCH` method guard. pub fn patch() -> Route

{ Route::new().method(Method::PATCH) } /// Create *route* with `DELETE` method guard. pub fn delete() -> Route

{ Route::new().method(Method::DELETE) } /// Create *route* with `HEAD` method guard. pub fn head() -> Route

{ Route::new().method(Method::HEAD) } /// Create *route* and add method guard. 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(handler: F) -> Route

where F: Factory + 'static, I: FromRequest

+ '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 { /// futures::future::ok(HttpResponse::Ok().finish()) /// } /// /// App::new().service(web::resource("/").route( /// web::to_async(index)) /// ); /// ``` pub fn to_async(handler: F) -> Route

where F: AsyncFactory, I: FromRequest

+ 'static, R: IntoFuture + 'static, R::Item: Into, R::Error: Into, { 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: F) -> impl Future> where F: FnOnce() -> Result + Send + 'static, I: Send + 'static, E: Send + std::fmt::Debug + 'static, { blocking::run(f).from_err() } use actix_service::{fn_transform, Service, Transform}; use crate::service::{ServiceRequest, ServiceResponse}; /// Create middleare pub fn md( f: F, ) -> impl Transform< S, Request = ServiceRequest

, Response = ServiceResponse, Error = Error, InitError = (), > where S: Service< Request = ServiceRequest

, Response = ServiceResponse, Error = Error, >, F: FnMut(ServiceRequest

, &mut S) -> R + Clone, R: IntoFuture, Error = Error>, { fn_transform(f) } }