Struct roa::cors::Builder

pub struct Builder { /* fields omitted */ }

Builder of Cors.

Methods

impl Builder

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

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

pub fn allow_method(self, method: Method) -> Self

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

pub fn allow_methods(self, methods: impl IntoIterator<Item = Method>) -> Self

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

pub fn allow_header<H>(self, header: H) -> Self where
    H: TryInto<HeaderName>,
    H::Error: Debug, 

Adds a header to the list of allowed request headers.

Panics

Panics if header is not a valid http::header::HeaderName.

pub fn allow_headers<I>(self, headers: I) -> Self where
    I: IntoIterator,
    I::Item: TryInto<HeaderName>,
    <I::Item as TryInto<HeaderName>>::Error: Debug, 

Adds multiple headers to the list of allowed request headers.

Panics

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

pub fn expose_header<H>(self, header: H) -> Self where
    H: TryInto<HeaderName>,
    H::Error: Debug, 

Adds a header to the list of exposed headers.

Panics

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

pub fn expose_headers<I>(self, headers: I) -> Self where
    I: IntoIterator,
    I::Item: TryInto<HeaderName>,
    <I::Item as TryInto<HeaderName>>::Error: Debug, 

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 allow_origin<H>(self, origin: H) -> Self where
    H: TryInto<HeaderValue>,
    H::Error: Debug, 

Add an origin to the existing list of allowed Origins.

Panics

Panics if the provided argument is not a valid HeaderValue.

pub fn max_age(self, seconds: u64) -> Self

Sets the Access-Control-Max-Age header.

pub fn build(self) -> Cors

Builds the Cors wrapper from the configured settings.

This step isn't required, as the Builder 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 Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the "default value" for a type.