Struct roa::cors::Cors

pub struct Cors { /* fields omitted */ }

A middleware to deal with Cross-Origin Resource Sharing (CORS).

Default

The default Cors middleware works well, it will use "origin" as value of response header "access-control-allow-origin",

And in preflight request, it will use "access-control-request-method" as value of "access-control-allow-methods" and use "access-control-request-headers" as value of "access-control-allow-headers".

Build a default Cors middleware:

use roa::cors::Cors;

let default_cors = Cors::new();

Config

You can also configure it:

use roa::cors::Cors;
use roa::http::header::{CONTENT_DISPOSITION, AUTHORIZATION, WWW_AUTHENTICATE};
use roa::http::Method;

let configured_cors = Cors::builder()
    .allow_credentials(true)
    .max_age(86400)
    .allow_origin("https://github.com")
    .allow_methods(vec![Method::GET, Method::POST])
    .allow_method(Method::PUT)
    .expose_headers(vec![CONTENT_DISPOSITION])
    .expose_header(WWW_AUTHENTICATE)
    .allow_headers(vec![AUTHORIZATION])
    .allow_header(CONTENT_DISPOSITION)
    .build();

Methods

impl Cors

pub fn new() -> Self

Construct default Cors.

pub fn builder() -> Builder

Get builder.

Trait Implementations

impl Debug for Cors

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for Cors

fn default() -> Cors

Returns the "default value" for a type.

impl<S: State> Middleware<S> for Cors

fn handle<'async_trait>(
    self: Arc<Self>,
    ctx: Context<S>,
    next: Next
) -> Pin<Box<dyn Future<Output = Result> + 'async_trait>> where
    Self: 'async_trait, 

Handle context and next, then return a future to get status.

fn end<'async_trait>(
    self: Arc<Self>,
    ctx: Context<S>
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'async_trait>> where
    Self: 'async_trait, 

Handle context as an endpoint.