Struct actix_web::middleware::cors::Cors
source · pub struct Cors { /* private fields */ }
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.
Implementations
sourceimpl Cors
impl Cors
sourcepub fn build() -> CorsBuilder<()>
pub fn build() -> CorsBuilder<()>
Build a new CORS middleware instance
sourcepub fn for_app<S: 'static>(app: App<S>) -> CorsBuilder<S>
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
);
}
sourcepub fn register<S: 'static>(self, resource: &mut Resource<S>)
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
sourceimpl<S> Middleware<S> for Cors
impl<S> Middleware<S> for Cors
sourcefn start(&self, req: &HttpRequest<S>) -> Result<Started>
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. Read more
sourcefn response(&self, req: &HttpRequest<S>, resp: HttpResponse) -> Result<Response>
fn response(&self, req: &HttpRequest<S>, resp: HttpResponse) -> Result<Response>
Method is called when handler returns response,
but before sending http message to peer. Read more
sourcefn finish(&self, req: &HttpRequest<S>, resp: &HttpResponse) -> Finished
fn finish(&self, req: &HttpRequest<S>, resp: &HttpResponse) -> Finished
Method is called after body stream get sent to peer.
Auto Trait Implementations
impl RefUnwindSafe for Cors
impl !Send for Cors
impl !Sync for Cors
impl Unpin for Cors
impl UnwindSafe for Cors
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more