1
0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-25 00:12:59 +01:00
actix-extras/src/lib.rs

237 lines
6.0 KiB
Rust
Raw Normal View History

//! Actix web is a small, pragmatic, and extremely fast web framework
//! for Rust.
2017-12-14 08:35:21 +01:00
//!
2018-01-09 19:08:06 +01:00
//! ```rust
2018-04-06 18:45:10 +02:00
//! use actix_web::{server, App, Path};
2018-01-09 19:08:06 +01:00
//! # use std::thread;
2017-12-14 08:35:21 +01:00
//!
2018-03-30 00:07:12 +02:00
//! fn index(info: Path<(String, u32)>) -> String {
//! format!("Hello {}! id:{}", info.0, info.1)
2017-12-14 08:35:21 +01:00
//! }
//!
//! fn main() {
2018-01-09 19:08:06 +01:00
//! # thread::spawn(|| {
2018-04-06 18:45:10 +02:00
//! server::new(
2018-03-31 09:16:55 +02:00
//! || App::new()
2018-03-30 00:07:12 +02:00
//! .resource("/{name}/{id}/index.html", |r| r.with(index)))
2018-01-09 19:08:06 +01:00
//! .bind("127.0.0.1:8080").unwrap()
//! .run();
//! # });
2017-12-14 08:35:21 +01:00
//! }
//! ```
//!
//! ## Documentation & community resources
//!
//! Besides the API documentation (which you are currently looking
//! at!), several other resources are available:
2017-12-14 08:35:21 +01:00
//!
//! * [User Guide](https://actix.rs/book/actix-web/)
2018-01-12 03:49:30 +01:00
//! * [Chat on gitter](https://gitter.im/actix/actix)
2018-01-12 03:47:34 +01:00
//! * [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](server/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 utilising them.
2017-12-14 08:35:21 +01:00
//!
//! ## Features
//!
//! * Supported *HTTP/1.x* and *HTTP/2.0* protocols
//! * Streaming and pipelining
//! * Keep-alive and slow requests handling
2018-02-26 23:33:56 +01:00
//! * `WebSockets` server/client
2017-12-14 08:35:21 +01:00
//! * Transparent content compression/decompression (br, gzip, deflate)
//! * Configurable request routing
2018-03-01 07:31:54 +01:00
//! * Graceful server shutdown
2017-12-14 08:35:21 +01:00
//! * Multipart streams
//! * SSL support with OpenSSL or `native-tls`
2018-03-08 06:39:20 +01:00
//! * Middlewares (`Logger`, `Session`, `CORS`, `CSRF`, `DefaultHeaders`)
//! * Built on top of [Actix actor framework](https://github.com/actix/actix)
//! * Supported Rust version: 1.21 or later
2017-10-07 06:48:14 +02:00
2017-11-24 19:28:43 +01:00
#![cfg_attr(actix_nightly, feature(
specialization, // for impl ErrorResponse for std::error::Error
))]
2018-04-24 21:24:04 +02:00
#![cfg_attr(
feature = "cargo-clippy",
allow(decimal_literal_representation, suspicious_arithmetic_impl)
)]
2017-10-07 06:48:14 +02:00
#[macro_use]
extern crate log;
2018-01-28 07:03:03 +01:00
extern crate base64;
extern crate byteorder;
2018-04-14 01:02:01 +02:00
extern crate bytes;
2017-10-17 04:21:24 +02:00
extern crate regex;
2018-04-14 01:02:01 +02:00
extern crate sha1;
extern crate time;
2017-10-07 06:48:14 +02:00
#[macro_use]
extern crate bitflags;
#[macro_use]
2017-12-29 10:01:31 +01:00
extern crate failure;
#[macro_use]
extern crate lazy_static;
#[macro_use]
2017-10-07 06:48:14 +02:00
extern crate futures;
extern crate cookie;
2018-04-14 01:02:01 +02:00
extern crate futures_cpupool;
2018-03-31 02:31:18 +02:00
extern crate http as modhttp;
extern crate http_range;
2018-04-14 01:02:01 +02:00
extern crate httparse;
extern crate language_tags;
extern crate libc;
2017-10-19 08:43:50 +02:00
extern crate mime;
2017-10-16 10:19:23 +02:00
extern crate mime_guess;
2018-04-14 01:02:01 +02:00
extern crate mio;
extern crate net2;
2018-01-28 07:03:03 +01:00
extern crate rand;
2018-04-14 01:02:01 +02:00
extern crate tokio_core;
extern crate tokio_io;
extern crate url;
2018-04-14 01:02:01 +02:00
#[macro_use]
extern crate serde;
#[cfg(feature = "brotli")]
2017-11-06 10:24:49 +01:00
extern crate brotli2;
extern crate encoding;
2018-04-24 21:24:04 +02:00
#[cfg(feature = "flate2")]
2018-04-14 01:02:01 +02:00
extern crate flate2;
extern crate h2 as http2;
extern crate num_cpus;
extern crate percent_encoding;
2018-04-14 01:02:01 +02:00
extern crate serde_json;
extern crate serde_urlencoded;
extern crate smallvec;
2018-04-14 01:02:01 +02:00
#[macro_use]
extern crate actix;
2017-10-07 06:48:14 +02:00
2017-12-04 03:51:52 +01:00
#[cfg(test)]
2018-04-14 01:02:01 +02:00
#[macro_use]
extern crate serde_derive;
2017-11-16 07:06:28 +01:00
2018-04-14 01:02:01 +02:00
#[cfg(feature = "tls")]
extern crate native_tls;
2018-04-14 01:02:01 +02:00
#[cfg(feature = "tls")]
extern crate tokio_tls;
2018-04-14 01:02:01 +02:00
#[cfg(feature = "openssl")]
extern crate openssl;
2018-04-14 01:02:01 +02:00
#[cfg(feature = "openssl")]
extern crate tokio_openssl;
2017-10-07 06:48:14 +02:00
mod application;
2017-10-24 08:25:32 +02:00
mod body;
2017-10-07 06:48:14 +02:00
mod context;
mod de;
mod extractor;
mod handler;
2018-03-31 02:31:18 +02:00
mod header;
mod helpers;
mod httpmessage;
mod httprequest;
2017-10-15 18:33:17 +02:00
mod httpresponse;
2017-12-06 02:09:15 +01:00
mod info;
2017-12-21 02:51:28 +01:00
mod json;
mod param;
mod payload;
2017-11-25 07:15:52 +01:00
mod pipeline;
2018-04-14 01:02:01 +02:00
mod resource;
mod route;
mod router;
2018-04-17 21:55:13 +02:00
mod uri;
2018-03-27 08:10:31 +02:00
mod with;
2017-10-08 06:48:00 +02:00
pub mod client;
2017-11-16 07:06:28 +01:00
pub mod error;
2018-04-14 01:02:01 +02:00
pub mod fs;
2017-12-27 04:59:41 +01:00
pub mod middleware;
2018-04-14 01:02:01 +02:00
pub mod multipart;
2017-12-04 22:32:05 +01:00
pub mod pred;
2018-01-12 03:35:05 +01:00
pub mod server;
2018-04-14 01:02:01 +02:00
pub mod test;
pub mod ws;
2018-03-31 09:16:55 +02:00
pub use application::App;
2018-04-14 01:02:01 +02:00
pub use body::{Binary, Body};
pub use context::HttpContext;
pub use error::{Error, ResponseError, Result};
pub use extractor::{Form, Path, Query};
pub use handler::{AsyncResponder, Either, FromRequest, FutureResponse, Responder, State};
pub use httpmessage::HttpMessage;
2017-12-08 01:40:29 +01:00
pub use httprequest::HttpRequest;
2017-11-27 07:53:28 +01:00
pub use httpresponse::HttpResponse;
2018-04-14 01:02:01 +02:00
pub use json::Json;
2017-10-14 19:40:58 +02:00
#[doc(hidden)]
pub mod httpcodes;
2018-03-31 09:16:55 +02:00
#[doc(hidden)]
#[allow(deprecated)]
pub use application::Application;
2018-04-14 01:02:01 +02:00
#[cfg(feature = "openssl")]
2018-01-30 08:01:20 +01:00
pub(crate) const HAS_OPENSSL: bool = true;
2018-04-14 01:02:01 +02:00
#[cfg(not(feature = "openssl"))]
2018-01-30 08:01:20 +01:00
pub(crate) const HAS_OPENSSL: bool = false;
2018-04-14 01:02:01 +02:00
#[cfg(feature = "tls")]
2018-03-07 02:34:46 +01:00
pub(crate) const HAS_TLS: bool = true;
2018-04-14 01:02:01 +02:00
#[cfg(not(feature = "tls"))]
2018-03-07 02:34:46 +01:00
pub(crate) const HAS_TLS: bool = false;
2018-01-30 08:01:20 +01:00
2017-12-07 02:06:40 +01:00
pub mod dev {
2018-04-14 01:02:01 +02:00
//! 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::*;
//! ```
2017-12-07 02:06:40 +01:00
2017-12-14 07:36:28 +01:00
pub use body::BodyStream;
2018-02-28 20:10:54 +01:00
pub use context::Drain;
2018-04-05 06:13:48 +02:00
pub use extractor::{FormConfig, PayloadConfig};
2018-04-14 01:02:01 +02:00
pub use handler::{Handler, Reply};
pub use httpmessage::{MessageBody, UrlEncoded};
2017-12-07 02:06:40 +01:00
pub use httpresponse::HttpResponseBuilder;
2018-04-14 01:02:01 +02:00
pub use info::ConnectionInfo;
pub use json::{JsonBody, JsonConfig};
pub use param::{FromParam, Params};
pub use resource::ResourceHandler;
pub use route::Route;
pub use router::{Resource, ResourceType, Router};
2017-12-07 02:06:40 +01:00
}
2018-03-31 02:31:18 +02:00
pub mod http {
//! Various HTTP related types
2018-03-31 02:31:18 +02:00
// re-exports
pub use modhttp::{Method, StatusCode, Version};
#[doc(hidden)]
2018-04-14 01:02:01 +02:00
pub use modhttp::{uri, Error, Extensions, HeaderMap, HttpTryFrom, Uri};
2018-03-31 02:31:18 +02:00
pub use cookie::{Cookie, CookieBuilder};
2018-04-14 01:02:01 +02:00
pub use http_range::HttpRange;
2018-03-31 02:31:18 +02:00
pub use helpers::NormalizePath;
pub mod header {
2018-04-14 01:02:01 +02:00
pub use header::*;
2018-03-31 02:31:18 +02:00
}
pub use header::ContentEncoding;
pub use httpresponse::ConnectionType;
}