Struct salvo_extra::cors::HandlerBuilder

pub struct HandlerBuilder { /* fields omitted */ }

A constructed via salvo_extra::cors::CorsHandler::builder().

Implementations

impl HandlerBuilder

pub fn new() -> Self

Create new HandlerBuilder.

pub fn with_allow_credentials(self, allow: bool) -> Self

Sets whether to add the Access-Control-Allow-Credentials header.

pub fn with_allow_method<M>(self, method: M) -> Self where
    Method: TryFrom<M>, 

Adds a method to the existing list of allowed request methods.

Panics

Panics if the provided argument is not a valid http::Method.

pub fn with_allow_methods<I>(self, methods: I) -> Self where
    I: IntoIterator,
    Method: TryFrom<I::Item>, 

Adds multiple methods to the existing list of allowed request methods.

Panics

Panics if the provided argument is not a valid http::Method.

pub fn with_allow_header<H>(self, header: H) -> Self where
    HeaderName: TryFrom<H>, 

Adds a header to the list of allowed request headers.

Note: These should match the values the browser sends via Access-Control-Request-Headers, e.g. content-type.

Panics

Panics if the provided argument is not a valid http::header::HeaderName.

pub fn with_allow_headers<I>(self, headers: I) -> Self where
    I: IntoIterator,
    HeaderName: TryFrom<I::Item>, 

Adds multiple headers to the list of allowed request headers.

Note: These should match the values the browser sends via Access-Control-Request-Headers, e.g.content-type.

Panics

Panics if any of the headers are not a valid http::header::HeaderName.

pub fn with_expose_header<H>(self, header: H) -> Self where
    HeaderName: TryFrom<H>, 

Adds a header to the list of exposed headers.

Panics

Panics if the provided argument is not a valid http::header::HeaderName.

pub fn with_expose_headers<I>(self, headers: I) -> Self where
    I: IntoIterator,
    HeaderName: TryFrom<I::Item>, 

Adds multiple headers to the list of exposed headers.

Panics

Panics if any of the headers are not a valid http::header::HeaderName.

pub fn with_allow_any_origin(self) -> Self

Sets that any Origin header is allowed.

Warning

This can allow websites you didn’t intend to access this resource, it is usually better to set an explicit list.

pub fn with_allow_origin(self, origin: impl IntoOrigin) -> Self

Add an origin to the existing list of allowed Origins.

Panics

Panics if the provided argument is not a valid Origin.

pub fn with_allow_origins<I>(self, origins: I) -> Self where
    I: IntoIterator,
    I::Item: IntoOrigin, 

Add multiple origins to the existing list of allowed Origins.

Panics

Panics if the provided argument is not a valid Origin.

pub fn with_max_age(self, seconds: impl Seconds) -> Self

Sets the Access-Control-Max-Age header.

Example

use std::time::Duration;
use salvo_core::prelude::*;;

let cors = salvo_extra::cors::CorsHandler::builder()
    .with_max_age(30) // 30u32 seconds
    .with_max_age(Duration::from_secs(30)); // or a Duration

pub fn build(self) -> CorsHandler

Builds the Cors wrapper from the configured settings.

This step isn’t required, as the HandlerBuilder itself can be passed to Filter::with. This just allows constructing once, thus not needing to pay the cost of “building” every time.

Trait Implementations

impl Clone for HandlerBuilder

fn clone(&self) -> HandlerBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HandlerBuilder

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

Formats the value using the given formatter.

impl Default for HandlerBuilder

fn default() -> Self

Returns the “default value” for a type.