1
0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-30 18:34:36 +01:00
actix-extras/actix-cors/src/lib.rs

61 lines
1.8 KiB
Rust
Raw Normal View History

2020-10-07 12:32:27 +02:00
//! Cross-Origin Resource Sharing (CORS) controls for Actix Web.
//!
2020-10-19 06:51:31 +02:00
//! This middleware can be applied to both applications and resources. Once built, a
//! [`Cors`] builder can be used as an argument for Actix Web's `App::wrap()`,
//! `Scope::wrap()`, or `Resource::wrap()` methods.
2018-01-10 08:55:42 +01:00
//!
//! This CORS middleware automatically handles `OPTIONS` preflight requests.
2018-01-10 08:55:42 +01:00
//!
//! # Example
//! ```rust,no_run
//! use actix_cors::Cors;
//! use actix_web::{get, http, web, App, HttpRequest, HttpResponse, HttpServer};
2018-01-10 08:55:42 +01:00
//!
//! #[get("/index.html")]
2019-11-22 06:49:35 +01:00
//! async fn index(req: HttpRequest) -> &'static str {
//! "<p>Hello World!</p>"
2018-01-10 08:55:42 +01:00
//! }
//!
//! #[actix_web::main]
//! async fn main() -> std::io::Result<()> {
//! HttpServer::new(|| {
2020-10-19 06:51:31 +02:00
//! let cors = Cors::default()
2019-03-24 05:29:16 +01:00
//! .allowed_origin("https://www.rust-lang.org/")
//! .allowed_origin_fn(|origin, _req_head| {
//! origin.as_bytes().ends_with(b".rust-lang.org")
//! })
2019-03-24 05:29:16 +01:00
//! .allowed_methods(vec!["GET", "POST"])
//! .allowed_headers(vec![http::header::AUTHORIZATION, http::header::ACCEPT])
//! .allowed_header(http::header::CONTENT_TYPE)
2020-10-19 06:51:31 +02:00
//! .max_age(3600);
//!
//! App::new()
//! .wrap(cors)
//! .service(index)
//! })
//! .bind(("127.0.0.1", 8080))?
//! .run()
//! .await;
2019-03-24 05:29:16 +01:00
//!
//! Ok(())
2018-01-10 08:55:42 +01:00
//! }
//! ```
#![forbid(unsafe_code)]
#![deny(rust_2018_idioms, nonstandard_style)]
#![warn(missing_docs, missing_debug_implementations)]
#![doc(html_logo_url = "https://actix.rs/img/logo.png")]
#![doc(html_favicon_url = "https://actix.rs/favicon.ico")]
mod all_or_some;
mod builder;
mod error;
mod inner;
mod middleware;
2020-10-19 06:51:31 +02:00
use all_or_some::AllOrSome;
pub use builder::Cors;
pub use error::CorsError;
2020-10-19 06:51:31 +02:00
use inner::{Inner, OriginFn};
pub use middleware::CorsMiddleware;