Struct gotham_restful::CorsConfig

pub struct CorsConfig {
    pub origin: Origin,
    pub headers: Vec<HeaderName>,
    pub max_age: u64,
    pub credentials: bool,
}

This is the configuration that the CORS handler will follow. Its default configuration is basically not to touch any responses, resulting in the browser’s default behaviour.

To change settings, you need to put this type into gotham’s State:

fn main() {
	let cors = CorsConfig {
		origin: Origin::Star,
		..Default::default()
	};
	let (chain, pipelines) = single_pipeline(new_pipeline().add(cors).build());
	gotham::start("127.0.0.1:8080", build_router(chain, pipelines, |route| {
		// your routing logic
	}));
}

This easy approach allows you to have one global cors configuration. If you prefer to have separate configurations for different scopes, you need to register the middleware inside your routing logic:

let pipelines = new_pipeline_set();

// The first cors configuration
let cors_a = CorsConfig {
	origin: Origin::Star,
	..Default::default()
};
let (pipelines, chain_a) = pipelines.add(
	new_pipeline().add(cors_a).build()
);

// The second cors configuration
let cors_b = CorsConfig {
	origin: Origin::Copy,
	..Default::default()
};
let (pipelines, chain_b) = pipelines.add(
	new_pipeline().add(cors_b).build()
);

let pipeline_set = finalize_pipeline_set(pipelines);
gotham::start("127.0.0.1:8080", build_router((), pipeline_set, |route| {
	// routing without any cors config
	route.with_pipeline_chain((chain_a, ()), |route| {
		// routing with cors config a
	});
	route.with_pipeline_chain((chain_b, ()), |route| {
		// routing with cors config b
	});
}));

Fields

origin: Origin

The allowed origins.

headers: Vec<HeaderName>

The allowed headers.

max_age: u64

The amount of seconds that the preflight request can be cached.

credentials: bool

Whether or not the request may be made with supplying credentials.

Trait Implementations

impl Clone for CorsConfig

fn clone(&self) -> CorsConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CorsConfig

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

Formats the value using the given formatter.

impl Default for CorsConfig

fn default() -> CorsConfig

Returns the “default value” for a type.

impl Middleware for CorsConfig

fn call<Chain>(self, state: State, chain: Chain) -> Pin<Box<HandlerFuture>> where
    Chain: FnOnce(State) -> Pin<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 CorsConfig

type Instance = Self

The type of Middleware created by the NewMiddleware.

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

Create and return a new Middleware value.

impl StateData for CorsConfig