Struct Cors

pub struct Cors<S> { /* private fields */ }

Middleware which adds headers for CORS.

See the module docs for an example.

Implementations

impl<S> Cors<S>

pub fn new(inner: S) -> Self

Create a new Cors.

See CorsLayer::new for more details.

pub fn permissive(inner: S) -> Self

A permissive configuration.

See CorsLayer::permissive for more details.

pub fn very_permissive(inner: S) -> Self

A very permissive configuration.

See CorsLayer::very_permissive for more details.

pub fn get_ref(&self) -> &S

Gets a reference to the underlying service.

pub fn get_mut(&mut self) -> &mut S

Gets a mutable reference to the underlying service.

pub fn into_inner(self) -> S

Consumes self, returning the underlying service.

pub fn layer() -> CorsLayer

Returns a new Layer that wraps services with a Cors middleware.

pub fn allow_credentials<T>(self, allow_credentials: T) -> Self

where T: Into<AllowCredentials>,

Set the Access-Control-Allow-Credentials header.

See CorsLayer::allow_credentials for more details.

pub fn allow_headers<T>(self, headers: T) -> Self

where T: Into<AllowHeaders>,

Set the value of the Access-Control-Allow-Headers header.

See CorsLayer::allow_headers for more details.

pub fn max_age<T>(self, max_age: T) -> Self

where T: Into<MaxAge>,

Set the value of the Access-Control-Max-Age header.

See CorsLayer::max_age for more details.

pub fn allow_methods<T>(self, methods: T) -> Self

where T: Into<AllowMethods>,

Set the value of the Access-Control-Allow-Methods header.

See CorsLayer::allow_methods for more details.

pub fn allow_origin<T>(self, origin: T) -> Self

where T: Into<AllowOrigin>,

Set the value of the Access-Control-Allow-Origin header.

See CorsLayer::allow_origin for more details.

pub fn expose_headers<T>(self, headers: T) -> Self

where T: Into<ExposeHeaders>,

Set the value of the Access-Control-Expose-Headers header.

See CorsLayer::expose_headers for more details.

pub fn allow_private_network<T>(self, allow_private_network: T) -> Self

where T: Into<AllowPrivateNetwork>,

Set the value of the Access-Control-Allow-Private-Network header.

See CorsLayer::allow_private_network for more details.

Trait Implementations

impl<S: Clone> Clone for Cors<S>

fn clone(&self) -> Cors<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Cors<S>

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

Formats the value using the given formatter.

impl<S, ReqBody, ResBody> Service<Request<ReqBody>> for Cors<S>

where S: Service<Request<ReqBody>, Response = Response<ResBody>>, ResBody: Default,

type Response = <S as Service<Request<ReqBody>>>::Response

Responses given by the service.

type Error = <S as Service<Request<ReqBody>>>::Error

Errors produced by the service.

type Future = ResponseFuture<<S as Service<Request<ReqBody>>>::Future>

The future response value.

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: Request<ReqBody>) -> Self::Future

Process the request and return the response asynchronously.