Struct actix_web::middleware::cors::Cors

[+] Show declaration

pub struct Cors { /* fields omitted */ }

[−] Expand description

Middleware for Cross-origin resource sharing support

The Cors struct contains the settings for CORS requests to be validated and for responses to be generated.

Methods

impl Cors

[−]

pub fn build() -> CorsBuilder<()>

[−]

Build a new CORS middleware instance

pub fn for_app<S: 'static>(app: App<S>) -> CorsBuilder<S>

[−]

Create CorsBuilder for a specified application.

use actix_web::middleware::cors::Cors;
use actix_web::{http, App, HttpResponse};

fn main() {
    let app = App::new().configure(
        |app| {
            Cors::for_app(app)   // <- Construct CORS builder
            .allowed_origin("https://www.rust-lang.org/")
            .resource("/resource", |r| {       // register resource
                 r.method(http::Method::GET).f(|_| HttpResponse::Ok());
            })
            .register()
        }, // construct CORS and return application instance
    );
}

pub fn register<S: 'static>(self, resource: &mut Resource<S>)

[−]

This method register cors middleware with resource and adds route for OPTIONS preflight requests.

It is possible to register Cors middleware with Resource::middleware() method, but in that case Cors middleware wont be able to handle OPTIONS requests.

Trait Implementations

impl Clone for Cors

[+]

fn clone(&self) -> Cors

[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

[−]

Performs copy-assignment from source.

impl Default for Cors

[+]

fn default() -> Cors

[−]

Returns the "default value" for a type.

impl<S> Middleware<S> for Cors

[+]

fn start(&self, req: &HttpRequest<S>) -> Result<Started>

[−]

Method is called when request is ready. It may return future, which should resolve before next middleware get called.

fn response(&self, req: &HttpRequest<S>, resp: HttpResponse) -> Result<Response>

[−]

Method is called when handler returns response, but before sending http message to peer.

fn finish(&self, req: &HttpRequest<S>, resp: &HttpResponse) -> Finished

[−]

Method is called after body stream get sent to peer.