# actix_web::middleware::cors::Cors - Rust
API documentation for the Rust `Cors` struct in crate `actix_web`.
Keywords: rust, rustlang, rust-lang, Cors

# [−] [src] Struct actix_web::middleware::cors::Cors

    pub struct Cors { /* fields omitted */ }

`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`

[src]

####

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

[src]

Build a new CORS middleware instance

####

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

[src]

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>)`

[src]

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<S> Middleware<S> for Cors`

[src]

####

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

[src]

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

####

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

[src]

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

####

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

[src]

Method is called after body stream get sent to peer.

###

`impl Default for Cors`

[src]

####

`fn default() -> Cors`

[src]

Returns the "default value" for a type. Read more

###

`impl Clone for Cors`

[src]

####

`fn clone(&self) -> Cors`

[src]

Returns a copy of the value. Read more

####

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

1.0.0
[src]

Performs copy-assignment from `source`. Read more

## Auto Trait Implementations

###

`impl !Send for Cors`

###

`impl !Sync for Cors`

## Blanket Implementations

###

`impl<T> ToOwned for T where T: Clone,`

[src]

#### `type Owned = T`

####

`fn to_owned(&self) -> T`

[src]

Creates owned data from borrowed data, usually by cloning. Read more

####

`fn clone_into(&self, target: &mut T)`

[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into`)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

###

`impl<T> From for T`

[src]

####

`fn from(t: T) -> T`

[src]

Performs the conversion.

###

`impl<T, U> Into for T where U: From<T>,`

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from`)

The type returned in the event of a conversion error.

####

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from`)

Performs the conversion.

###

`impl<T> Borrow for T where T: ?Sized,`

[src]

####

`fn borrow(&self) -> &T`

[src]

Immutably borrows from an owned value. Read more

###

`impl<T> BorrowMut for T where T: ?Sized,`

[src]

####

`fn borrow_mut(&mut self) -> &mut T`

[src]

Mutably borrows from an owned value. Read more

###

`impl<T, U> TryInto for T where U: TryFrom<T>,`

[src]

#### `type Error = <U as TryFrom<T>>::Error`

🔬 This is a nightly-only experimental API. (`try_from`)

The type returned in the event of a conversion error.

####

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from`)

Performs the conversion.

###

`impl<T> Any for T where T: 'static + ?Sized,`

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

🔬 This is a nightly-only experimental API. (`get_type_id`)

this method will likely be replaced by an associated static

Gets the `TypeId` of `self`. Read more

###

`impl<T> Erased for T`

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)