Struct poem::middleware::Cors

pub struct Cors { /* private fields */ }

Middleware for CORS

Errors

• CorsError

Example

use poem::{http::Method, middleware::Cors};

let cors = Cors::new()
    .allow_method(Method::GET)
    .allow_method(Method::POST)
    .allow_credentials(false);

Implementations

impl Cors

pub fn new() -> Self

Creates a new CORS middleware.

pub fn allow_credentials(self, allow_credentials: bool) -> Self

Set allow credentials.

pub fn allow_header<T>(self, header: T) -> Selfwhere
    HeaderName: TryFrom<T>,

Add an allow header.

NOTE: Default is allow any header.

pub fn allow_headers<I, T>(self, headers: I) -> Selfwhere
    I: IntoIterator<Item = T>,
    HeaderName: TryFrom<T>,

Add many allow headers.

pub fn allow_method<T>(self, method: T) -> Selfwhere
    Method: TryFrom<T>,

Add an allow method.

NOTE: Default is allow any method.

pub fn allow_methods<I, T>(self, methods: I) -> Selfwhere
    I: IntoIterator<Item = T>,
    Method: TryFrom<T>,

Add many allow methods.

pub fn allow_origin<T>(self, origin: T) -> Selfwhere
    HeaderValue: TryFrom<T>,

Add an allow origin.

NOTE: Default is allow any origin.

pub fn allow_origins<I, T>(self, origins: I) -> Selfwhere
    I: IntoIterator<Item = T>,
    HeaderValue: TryFrom<T>,

Add many allow origins.

pub fn allow_origins_fn<F>(self, f: F) -> Selfwhere
    F: Fn(&str) -> bool + Send + Sync + 'static,

Determinate allowed origins by processing requests which didn’t match any origins specified in the allow_origin.

This function will receive the Origin header, which can be used to determine whether to allow the request.

pub fn expose_header<T>(self, header: T) -> Selfwhere
    HeaderName: TryFrom<T>,

Add an expose header.

pub fn expose_headers<I, T>(self, headers: I) -> Selfwhere
    I: IntoIterator<Item = T>,
    HeaderName: TryFrom<T>,

Add many expose headers.

pub fn max_age(self, max_age: i32) -> Self

Set max age.

Trait Implementations

impl Default for Cors

fn default() -> Cors

Returns the “default value” for a type.

impl<E: Endpoint> Middleware<E> for Cors

type Output = CorsEndpoint<E>

New endpoint type.

fn transform(&self, ep: E) -> Self::Output

Transform the input Endpoint to another one.