mirror of https://github.com/fafhrd91/actix-web
121 lines
4.0 KiB
Rust
121 lines
4.0 KiB
Rust
//! Actix Web is a powerful, pragmatic, and extremely fast web framework for Rust.
|
|
//!
|
|
//! # Examples
|
|
//! ```no_run
|
|
//! 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:
|
|
//!
|
|
//! * [Website & User Guide](https://actix.rs/)
|
|
//! * [Examples Repository](https://github.com/actix/examples)
|
|
//! * [Community Chat on Discord](https://discord.gg/NWpN5mmg3x)
|
|
//!
|
|
//! To get started navigating the API docs, you may consider looking at the following pages first:
|
|
//!
|
|
//! * [`App`]: This struct represents an Actix Web application and is used to
|
|
//! configure routes and other common application settings.
|
|
//!
|
|
//! * [`HttpServer`]: This struct represents an HTTP server instance and is
|
|
//! used to instantiate and configure servers.
|
|
//!
|
|
//! * [`web`]: This module provides essential types for route registration as well as
|
|
//! common utilities for request handlers.
|
|
//!
|
|
//! * [`HttpRequest`] and [`HttpResponse`]: These
|
|
//! structs represent HTTP requests and responses and expose methods for creating, inspecting,
|
|
//! and otherwise utilizing them.
|
|
//!
|
|
//! # Features
|
|
//! * Supports *HTTP/1.x* and *HTTP/2*
|
|
//! * Streaming and pipelining
|
|
//! * Keep-alive and slow requests handling
|
|
//! * Client/server [WebSockets](https://actix.rs/docs/websockets/) support
|
|
//! * Transparent content compression/decompression (br, gzip, deflate, zstd)
|
|
//! * Powerful [request routing](https://actix.rs/docs/url-dispatch/)
|
|
//! * Multipart streams
|
|
//! * Static assets
|
|
//! * SSL support using OpenSSL or Rustls
|
|
//! * Middlewares ([Logger, Session, CORS, etc](https://actix.rs/docs/middleware/))
|
|
//! * Includes an async [HTTP client](https://docs.rs/awc/)
|
|
//! * Runs on stable Rust 1.52+
|
|
//!
|
|
//! # Crate Features
|
|
//! * `cookies` - cookies support (enabled by default)
|
|
//! * `compress-brotli` - brotli content encoding compression support (enabled by default)
|
|
//! * `compress-gzip` - gzip and deflate content encoding compression support (enabled by default)
|
|
//! * `compress-zstd` - zstd content encoding compression support (enabled by default)
|
|
//! * `openssl` - HTTPS support via `openssl` crate, supports `HTTP/2`
|
|
//! * `rustls` - HTTPS support via `rustls` crate, supports `HTTP/2`
|
|
//! * `secure-cookies` - secure cookies support
|
|
|
|
#![deny(rust_2018_idioms, nonstandard_style)]
|
|
#![warn(future_incompatible)]
|
|
#![allow(clippy::needless_doctest_main, clippy::type_complexity)]
|
|
#![doc(html_logo_url = "https://actix.rs/img/logo.png")]
|
|
#![doc(html_favicon_url = "https://actix.rs/favicon.ico")]
|
|
|
|
mod app;
|
|
mod app_service;
|
|
mod config;
|
|
mod data;
|
|
pub mod dev;
|
|
pub mod error;
|
|
mod extract;
|
|
pub mod guard;
|
|
mod handler;
|
|
mod helpers;
|
|
pub mod http;
|
|
mod info;
|
|
pub mod middleware;
|
|
mod request;
|
|
mod request_data;
|
|
mod resource;
|
|
mod responder;
|
|
mod response;
|
|
mod rmap;
|
|
mod route;
|
|
mod scope;
|
|
mod server;
|
|
mod service;
|
|
pub mod test;
|
|
pub(crate) mod types;
|
|
pub mod web;
|
|
|
|
pub use actix_http::{body, HttpMessage};
|
|
#[doc(inline)]
|
|
pub use actix_rt as rt;
|
|
pub use actix_web_codegen::*;
|
|
#[cfg(feature = "cookies")]
|
|
pub use cookie;
|
|
|
|
pub use crate::app::App;
|
|
pub use crate::error::{Error, ResponseError, Result};
|
|
pub use crate::extract::FromRequest;
|
|
pub use crate::request::HttpRequest;
|
|
pub use crate::resource::Resource;
|
|
pub use crate::responder::Responder;
|
|
pub use crate::response::{HttpResponse, HttpResponseBuilder};
|
|
pub use crate::route::Route;
|
|
pub use crate::scope::Scope;
|
|
pub use crate::server::HttpServer;
|
|
// TODO: is exposing the error directly really needed
|
|
pub use crate::types::{Either, EitherExtractError};
|
|
|
|
pub(crate) type BoxError = Box<dyn std::error::Error>;
|