Crate actix_web[][src]

Actix Web is a powerful, pragmatic, and extremely fast web framework for Rust.

Example

use actix_web::{get, web, App, HttpServer, Responder};

#[get("/{id}/{name}/index.html")]
async fn index(path: web::Path<(u32, String)>) -> impl Responder {
    let (id, name) = path.into_inner();
    format!("Hello {}! id:{}", name, id)
}

#[actix_web::main]
async fn main() -> std::io::Result<()> {
    HttpServer::new(|| App::new().service(index))
        .bind("127.0.0.1:8080")?
        .run()
        .await
}

Documentation & Community Resources

In addition to this API documentation, several other resources are available:

To get started navigating the API docs, you may consider looking at the following pages first:

Features

Crate Features

Re-exports

pub use cookie;

Modules

body

Traits and structures to aid consuming and writing HTTP payloads.

dev

The actix-web prelude for library developers

error

Error and Result module

guard

Route match guards.

http
middleware

Commonly used middleware.

rt

Tokio-based single-threaded async runtime for the Actix ecosystem.

test

Various helpers for Actix applications to use during testing.

web

Essentials helper functions and types for application registration.

Macros

services

Macro helping register different types of services at the sametime.

Structs

App

Application builder - structure that follows the builder pattern for building application instances.

BaseHttpResponse

An HTTP response.

Error

General purpose actix web error.

HttpRequest

An HTTP Request

HttpResponse

An HTTP Response

HttpResponseBuilder

An HTTP response builder.

HttpServer

An HTTP Server.

Resource

Resource is an entry in resources table which corresponds to requested URL.

Route

Resource route definition

Scope

Resources scope.

Enums

Either

Combines two extractor or responder types into a single type.

EitherExtractError

A composite error resulting from failure to extract an Either<L, R>.

Traits

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 can be converted to an HTTP response.

ResponseError

Error that can be converted to Response

Type Definitions

Result

A specialized std::result::Result for actix web operations

Attribute Macros

connect

Creates route handler with actix_web::guard::Connect.

delete

Creates route handler with actix_web::guard::Delete.

get

Creates route handler with actix_web::guard::Get.

head

Creates route handler with actix_web::guard::Head.

main

Marks async main function as the actix system entry-point.

options

Creates route handler with actix_web::guard::Options.

patch

Creates route handler with actix_web::guard::Patch.

post

Creates route handler with actix_web::guard::Post.

put

Creates route handler with actix_web::guard::Put.

route

Creates resource handler, allowing multiple HTTP method guards.

trace

Creates route handler with actix_web::guard::Trace.