mirror of
https://github.com/fafhrd91/actix-web
synced 2024-11-25 00:43:00 +01:00
190 lines
4.6 KiB
Rust
190 lines
4.6 KiB
Rust
//! Actix web is a small, pragmatic, extremely fast, web framework for Rust.
|
|
//!
|
|
//! ```rust
|
|
//! use actix_web::*;
|
|
//! # use std::thread;
|
|
//!
|
|
//! fn index(req: HttpRequest) -> String {
|
|
//! format!("Hello {}!", &req.match_info()["name"])
|
|
//! }
|
|
//!
|
|
//! fn main() {
|
|
//! # thread::spawn(|| {
|
|
//! HttpServer::new(
|
|
//! || Application::new()
|
|
//! .resource("/{name}", |r| r.f(index)))
|
|
//! .bind("127.0.0.1:8080").unwrap()
|
|
//! .run();
|
|
//! # });
|
|
//! }
|
|
//! ```
|
|
//!
|
|
//! ## Documentation
|
|
//!
|
|
//! * [User Guide](http://actix.github.io/actix-web/guide/)
|
|
//! * [Chat on gitter](https://gitter.im/actix/actix)
|
|
//! * [GitHub repository](https://github.com/actix/actix-web)
|
|
//! * [Cargo package](https://crates.io/crates/actix-web)
|
|
//! * Supported Rust version: 1.21 or later
|
|
//!
|
|
//! ## 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](https://github.com/actix/actix).
|
|
|
|
#![cfg_attr(actix_nightly, feature(
|
|
specialization, // for impl ErrorResponse for std::error::Error
|
|
))]
|
|
#![cfg_attr(feature = "cargo-clippy", allow(
|
|
decimal_literal_representation,suspicious_arithmetic_impl,))]
|
|
|
|
#[macro_use]
|
|
extern crate log;
|
|
extern crate time;
|
|
extern crate base64;
|
|
extern crate bytes;
|
|
extern crate byteorder;
|
|
extern crate sha1;
|
|
extern crate regex;
|
|
#[macro_use]
|
|
extern crate bitflags;
|
|
#[macro_use]
|
|
extern crate failure;
|
|
#[macro_use]
|
|
extern crate futures;
|
|
extern crate futures_cpupool;
|
|
extern crate tokio_io;
|
|
extern crate tokio_core;
|
|
extern crate mio;
|
|
extern crate net2;
|
|
extern crate cookie;
|
|
extern crate http;
|
|
extern crate httparse;
|
|
extern crate http_range;
|
|
extern crate mime;
|
|
extern crate mime_guess;
|
|
extern crate language_tags;
|
|
extern crate rand;
|
|
extern crate url;
|
|
extern crate libc;
|
|
extern crate serde;
|
|
extern crate serde_json;
|
|
extern crate flate2;
|
|
extern crate brotli2;
|
|
extern crate encoding;
|
|
extern crate percent_encoding;
|
|
extern crate smallvec;
|
|
extern crate num_cpus;
|
|
extern crate h2 as http2;
|
|
extern crate trust_dns_resolver;
|
|
#[macro_use] extern crate actix;
|
|
|
|
#[cfg(test)]
|
|
#[macro_use] extern crate serde_derive;
|
|
|
|
#[cfg(feature="tls")]
|
|
extern crate native_tls;
|
|
#[cfg(feature="tls")]
|
|
extern crate tokio_tls;
|
|
|
|
#[cfg(feature="openssl")]
|
|
extern crate openssl;
|
|
#[cfg(feature="openssl")]
|
|
extern crate tokio_openssl;
|
|
|
|
mod application;
|
|
mod body;
|
|
mod context;
|
|
mod handler;
|
|
mod helpers;
|
|
mod httpmessage;
|
|
mod httprequest;
|
|
mod httpresponse;
|
|
mod info;
|
|
mod json;
|
|
mod route;
|
|
mod router;
|
|
mod resource;
|
|
mod param;
|
|
mod payload;
|
|
mod pipeline;
|
|
|
|
pub mod client;
|
|
pub mod fs;
|
|
pub mod ws;
|
|
pub mod error;
|
|
pub mod header;
|
|
pub mod httpcodes;
|
|
pub mod multipart;
|
|
pub mod middleware;
|
|
pub mod pred;
|
|
pub mod test;
|
|
pub mod server;
|
|
pub use error::{Error, Result, ResponseError};
|
|
pub use body::{Body, Binary};
|
|
pub use json::Json;
|
|
pub use application::Application;
|
|
pub use httpmessage::HttpMessage;
|
|
pub use httprequest::HttpRequest;
|
|
pub use httpresponse::HttpResponse;
|
|
pub use handler::{Reply, Responder, NormalizePath, AsyncResponder};
|
|
pub use route::Route;
|
|
pub use resource::Resource;
|
|
pub use context::HttpContext;
|
|
pub use server::HttpServer;
|
|
|
|
// re-exports
|
|
pub use http::{Method, StatusCode, Version};
|
|
|
|
#[cfg(feature="openssl")]
|
|
pub(crate) const HAS_OPENSSL: bool = true;
|
|
#[cfg(not(feature="openssl"))]
|
|
pub(crate) const HAS_OPENSSL: bool = false;
|
|
|
|
#[cfg(feature="tls")]
|
|
pub(crate) const HAS_TLS: bool = true;
|
|
#[cfg(not(feature="tls"))]
|
|
pub(crate) const HAS_TLS: bool = false;
|
|
|
|
#[doc(hidden)]
|
|
#[deprecated(since="0.4.4", note="please use `actix::header` module")]
|
|
pub mod headers {
|
|
//! Headers implementation
|
|
|
|
pub use httpresponse::ConnectionType;
|
|
pub use cookie::{Cookie, CookieBuilder};
|
|
pub use http_range::HttpRange;
|
|
pub use header::ContentEncoding;
|
|
}
|
|
|
|
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 body::BodyStream;
|
|
pub use context::Drain;
|
|
pub use info::ConnectionInfo;
|
|
pub use handler::Handler;
|
|
pub use json::JsonBody;
|
|
pub use router::{Router, Pattern};
|
|
pub use param::{FromParam, Params};
|
|
pub use httpmessage::{UrlEncoded, MessageBody};
|
|
pub use httpresponse::HttpResponseBuilder;
|
|
}
|