1
0
mirror of https://github.com/fafhrd91/actix-web synced 2024-12-02 19:32:24 +01:00
actix-web/src/lib.rs

195 lines
6.1 KiB
Rust
Raw Normal View History

2019-03-24 19:47:23 +01:00
//! Actix web is a small, pragmatic, and extremely fast web framework
//! for Rust.
//!
//! ```rust
//! use actix_web::{web, App, Responder, HttpServer};
//! # use std::thread;
//!
//! fn index(info: web::Path<(String, u32)>) -> impl Responder {
//! format!("Hello {}! id:{}", info.0, info.1)
//! }
//!
//! fn main() -> std::io::Result<()> {
//! # thread::spawn(|| {
//! HttpServer::new(|| App::new().service(
//! web::resource("/{name}/{id}/index.html").to(index))
//! )
//! .bind("127.0.0.1:8080")?
//! .run()
//! # });
//! # Ok(())
//! }
//! ```
//!
//! ## Documentation & community resources
//!
//! Besides the API documentation (which you are currently looking
//! at!), several other resources are available:
//!
//! * [User Guide](https://actix.rs/docs/)
//! * [Chat on gitter](https://gitter.im/actix/actix)
//! * [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](struct.HttpServer.html): This struct
//! represents an HTTP server instance and is used to instantiate and
//! configure servers.
//!
2019-03-30 18:04:38 +01:00
//! * [web](web/index.html): This module
//! provide essentials helper functions and types for application registration.
//!
2019-03-24 19:47:23 +01:00
//! * [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 utilizing 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
//! * Multipart streams
//! * SSL support with OpenSSL or `native-tls`
//! * Middlewares (`Logger`, `Session`, `CORS`, `CSRF`, `DefaultHeaders`)
//! * Supports [Actix actor framework](https://github.com/actix/actix)
2019-04-01 19:26:09 +02:00
//! * Supported Rust version: 1.31 or later
2019-03-24 19:47:23 +01:00
//!
//! ## Package feature
//!
2019-03-26 05:58:01 +01:00
//! * `client` - enables http client
2019-03-24 19:47:23 +01:00
//! * `tls` - enables ssl support via `native-tls` crate
//! * `ssl` - enables ssl support via `openssl` crate, supports `http/2`
//! * `rust-tls` - enables ssl support via `rustls` crate, supports `http/2`
2019-03-30 18:04:38 +01:00
//! * `secure-cookies` - enables secure cookies support, includes `ring` crate as
2019-03-24 19:47:23 +01:00
//! dependency
//! * `brotli` - enables `brotli` compression support, requires `c`
//! compiler
2019-03-27 02:46:06 +01:00
//! * `flate2-zlib` - enables `gzip`, `deflate` compression support, requires
2019-03-24 19:47:23 +01:00
//! `c` compiler
//! * `flate2-rust` - experimental rust based implementation for
//! `gzip`, `deflate` compression.
//!
#![allow(clippy::type_complexity, clippy::new_without_default)]
2019-03-02 07:51:32 +01:00
mod app;
mod app_service;
mod config;
2019-03-17 04:17:27 +01:00
mod data;
pub mod error;
mod extract;
2019-03-03 21:09:38 +01:00
pub mod guard;
mod handler;
mod info;
2017-12-27 04:59:41 +01:00
pub mod middleware;
2019-03-02 07:51:32 +01:00
mod request;
mod resource;
mod responder;
mod rmap;
2019-03-02 07:51:32 +01:00
mod route;
2019-03-04 06:02:01 +01:00
mod scope;
2019-03-05 01:29:03 +01:00
mod server;
2019-03-02 07:51:32 +01:00
mod service;
2019-03-03 01:24:14 +01:00
pub mod test;
2019-03-17 05:43:48 +01:00
mod types;
2019-03-30 18:04:38 +01:00
pub mod web;
2019-03-02 07:51:32 +01:00
2019-03-07 22:33:40 +01:00
#[allow(unused_imports)]
#[macro_use]
extern crate actix_web_codegen;
#[doc(hidden)]
pub use actix_web_codegen::*;
2019-03-02 07:51:32 +01:00
// re-export for convenience
pub use actix_http::Response as HttpResponse;
2019-03-30 05:13:39 +01:00
pub use actix_http::{cookie, http, Error, HttpMessage, ResponseError, Result};
2019-03-02 07:51:32 +01:00
pub use crate::app::App;
2019-03-07 20:43:46 +01:00
pub use crate::extract::FromRequest;
2019-03-02 07:51:32 +01:00
pub use crate::request::HttpRequest;
pub use crate::resource::Resource;
pub use crate::responder::{Either, Responder};
pub use crate::route::Route;
2019-03-24 19:59:35 +01:00
pub use crate::scope::Scope;
2019-03-05 01:29:03 +01:00
pub use crate::server::HttpServer;
2018-07-29 08:43:04 +02:00
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 crate::app::AppRouter;
pub use crate::config::{AppConfig, ServiceConfig};
pub use crate::info::ConnectionInfo;
pub use crate::rmap::ResourceMap;
pub use crate::service::{
HttpServiceFactory, ServiceFromRequest, ServiceRequest, ServiceResponse,
};
2019-03-17 08:48:40 +01:00
pub use crate::types::form::UrlEncoded;
2019-03-17 06:04:09 +01:00
pub use crate::types::json::JsonBody;
2019-03-17 08:48:40 +01:00
pub use crate::types::readlines::Readlines;
2019-03-27 17:24:55 +01:00
pub use actix_http::body::{Body, BodySize, MessageBody, ResponseBody};
2019-03-17 09:08:56 +01:00
pub use actix_http::ResponseBuilder as HttpResponseBuilder;
pub use actix_http::{
2019-03-27 18:38:01 +01:00
Extensions, Payload, PayloadStream, RequestHead, ResponseHead,
};
pub use actix_router::{Path, ResourceDef, ResourcePath, Url};
pub use actix_server::Server;
pub(crate) fn insert_slash(path: &str) -> String {
let mut path = path.to_owned();
if !path.is_empty() && !path.starts_with('/') {
path.insert(0, '/');
};
path
}
}
2019-03-27 17:24:55 +01:00
#[cfg(feature = "client")]
pub mod client {
//! An HTTP Client
//!
//! ```rust
//! # use futures::future::{Future, lazy};
//! use actix_rt::System;
//! use actix_web::client::Client;
//!
//! fn main() {
//! System::new("test").block_on(lazy(|| {
//! let mut client = Client::default();
//!
//! client.get("http://www.rust-lang.org") // <- Create request builder
//! .header("User-Agent", "Actix-web")
//! .send() // <- Send http request
//! .map_err(|_| ())
//! .and_then(|response| { // <- server http response
//! println!("Response: {:?}", response);
//! Ok(())
//! })
//! }));
//! }
//! ```
2019-03-28 02:53:19 +01:00
pub use awc::error::{
ConnectError, InvalidUrl, PayloadError, SendRequestError, WsClientError,
2019-03-27 17:24:55 +01:00
};
pub use awc::{test, Client, ClientBuilder, ClientRequest, ClientResponse,
Connector};
2019-03-27 17:24:55 +01:00
}