Crate actix_web [−] [src]
Actix web is a small, pragmatic, and extremely fast web framework for Rust.
use actix_web::{server, App, Path}; fn index(info: Path<(String, u32)>) -> String { format!("Hello {}! id:{}", info.0, info.1) } fn main() { server::new( || App::new() .resource("/{name}/{id}/index.html", |r| r.with(index))) .bind("127.0.0.1:8080").unwrap() .run(); }
Documentation & community resources
Besides the API documentation (which you are currently looking at!), several other resources are available:
To get started navigating the API documentation you may want to consider looking at the following pages:
-
App: This struct represents an actix-web application and is used to configure routes and other common settings.
-
HttpServer: This struct represents an HTTP server instance and is used to instantiate and configure servers.
-
HttpRequest and HttpResponse: These structs represent HTTP requests and responses and expose various methods for inspecting, creating and otherwise utilising 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
- Graceful server shutdown
- Multipart streams
- SSL support with OpenSSL or
native-tls
- Middlewares (
Logger
,Session
,CORS
,CSRF
,DefaultHeaders
) - Built on top of Actix actor framework
- Supported Rust version: 1.21 or later
Re-exports
pub use error::Error; |
pub use error::ResponseError; |
pub use error::Result; |
Modules
client |
Http client api |
dev |
The |
error |
Error and Result module |
fs |
Static files support |
http |
Various HTTP related types |
middleware |
Middlewares |
multipart |
Multipart requests support |
pred |
Route match predicates |
server |
Http server |
test |
Various helpers for Actix applications to use during testing. |
ws |
|
Macros
header |
Structs
App |
Structure that follows the builder pattern for building application instances. |
Form |
Extract typed information from the request's body. |
HttpContext |
Execution context for http actors |
HttpRequest |
An HTTP Request |
HttpResponse |
An HTTP Response |
Json |
Json helper |
Path |
Extract typed information from the request's path. |
Query |
Extract typed information from from the request's query. |
State |
Access an application state |
Enums
Binary |
Represents various types of binary body.
|
Body |
Represents various types of http message body. |
Either |
Combines two different responder types into a single type |
Traits
AsyncResponder |
Convenience trait that converts |
FromRequest |
Trait implemented by types that can be extracted from request. |
HttpMessage |
Trait that implements general purpose operations on http messages |
Responder |
Trait implemented by types that generate responses for clients. |
Type Definitions
FutureResponse |
Convenience type alias |