Struct gotham_cors_middleware::CORSMiddleware

pub struct CORSMiddleware { /* private fields */ }

Struct to perform the necessary CORS functionality needed. Allows some customisation through use of the new() function.

Example of use:

extern crate gotham;
extern crate gotham_cors_middleware;

use gotham::pipeline::new_pipeline;
use gotham_cors_middleware::CORSMiddleware;
use gotham::pipeline::single::single_pipeline;
use gotham::router::builder::*;
use gotham::router::Router;

pub fn router() -> Router {
    let (chain, pipeline) = single_pipeline(
        new_pipeline()
            .add(CORSMiddleware::default())
            .build()
    );

    build_router(chain, pipeline, |route| {
        // Routes
    })
}

Implementations

impl CORSMiddleware

pub fn new(
    methods: Vec<Method>,
    origin: Option<String>,
    max_age: u32
) -> CORSMiddleware

Create a new CORSMiddleware with custom methods, origin and max_age properties.

Expects methods to be a Vec of hyper::Method enum values, origin to be an Option containing a String (so allows for None values - which defaults to returning the sender origin on request or returning a string of “*” - see the call function source) and max age to be a u32 value.

Example of use:

extern crate gotham;
extern crate gotham_cors_middleware;
extern crate hyper;

use gotham::pipeline::new_pipeline;
use gotham_cors_middleware::CORSMiddleware;
use gotham::pipeline::single::single_pipeline;
use gotham::router::builder::*;
use gotham::router::Router;
use hyper::Method;

fn create_custom_middleware() -> CORSMiddleware {
    let methods = vec![Method::Delete, Method::Get, Method::Head, Method::Options];

    let max_age = 1000;

    let origin = Some("http://www.example.com".to_string());

    CORSMiddleware::new(methods, origin, max_age)
}

pub fn router() -> Router {
    let (chain, pipeline) = single_pipeline(
        new_pipeline()
            .add(create_custom_middleware())
            .build()
    );

    build_router(chain, pipeline, |route| {
        // Routes
    })
}

pub fn default() -> CORSMiddleware

Creates a new CORSMiddleware with what is currently the “default” values for methods/origin/max_age.

This is based off the values that were used previously before they were customisable. If you need different values, use the new() function.

Trait Implementations

impl Clone for CORSMiddleware

fn clone(&self) -> CORSMiddleware

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CORSMiddleware

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

Formats the value using the given formatter.

impl Middleware for CORSMiddleware

fn call<Chain>(self, state: State, chain: Chain) -> Box<HandlerFuture>where
    Chain: FnOnce(State) -> Box<HandlerFuture>,

Entry point to the middleware. To pass the request on to the application, the middleware invokes the chain function with the provided state.

impl NewMiddleware for CORSMiddleware

type Instance = CORSMiddleware

The type of Middleware created by the NewMiddleware.

fn new_middleware(&self) -> Result<Self>

Create and return a new Middleware value.

impl PartialEq<CORSMiddleware> for CORSMiddleware

fn eq(&self, other: &CORSMiddleware) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CORSMiddleware