Struct CorsHeaders 

#[non_exhaustive]
pub struct CorsHeaders {
    pub allow_origin: Option<CorsOrigin>,
    pub allow_methods: Option<Vec<String>>,
    pub allow_headers: Option<Vec<String>>,
    pub expose_headers: Option<Vec<String>>,
    pub max_age: Option<u64>,
    pub allow_credentials: Option<bool>,
}

Structured CORS response headers.

All fields are Option so that headers can be omitted when not needed. Use the builder methods to set individual fields.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

allow_origin: Option<CorsOrigin>

Access-Control-Allow-Origin

allow_methods: Option<Vec<String>>

Access-Control-Allow-Methods

allow_headers: Option<Vec<String>>

Access-Control-Allow-Headers

expose_headers: Option<Vec<String>>

Access-Control-Expose-Headers

max_age: Option<u64>

Access-Control-Max-Age (seconds)

allow_credentials: Option<bool>

Access-Control-Allow-Credentials

Implementations

impl CorsHeaders

pub fn new() -> Self

Create a new, empty CorsHeaders.

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

Set Access-Control-Allow-Origin.

use api_bones::cors::{CorsHeaders, CorsOrigin};

let cors = CorsHeaders::new().allow_origin(CorsOrigin::Any);
assert_eq!(cors.allow_origin.unwrap().to_string(), "*");

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

where I: IntoIterator, I::Item: Into<String>,

Set Access-Control-Allow-Methods from an iterator of method strings.

use api_bones::cors::CorsHeaders;

let cors = CorsHeaders::new().allow_methods(["GET", "POST"]);
let methods = cors.allow_methods.unwrap();
assert!(methods.contains(&"GET".to_string()));

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

where I: IntoIterator, I::Item: Into<String>,

Set Access-Control-Allow-Headers from an iterator of header names.

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

where I: IntoIterator, I::Item: Into<String>,

Set Access-Control-Expose-Headers from an iterator of header names.

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

Set Access-Control-Max-Age (seconds).

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

Set Access-Control-Allow-Credentials.

Note: per the spec, Allow-Credentials: true is incompatible with Allow-Origin: *. This is not enforced at the type level but callers should be careful.

pub fn preflight<M, H>(origin: CorsOrigin, methods: M, headers: H) -> Self

where M: IntoIterator, M::Item: Into<String>, H: IntoIterator, H::Item: Into<String>,

Build a preflight (OPTIONS) response with sensible defaults.

Sets Allow-Origin, Allow-Methods, and Allow-Headers. Does not set Allow-Credentials (default: absent, treated as false by browsers).

use api_bones::cors::{CorsHeaders, CorsOrigin};

let preflight = CorsHeaders::preflight(
    CorsOrigin::Origin("https://example.com".into()),
    ["GET", "POST"],
    ["Content-Type"],
);
assert!(preflight.allow_methods.is_some());
assert!(preflight.allow_headers.is_some());

pub fn allow_methods_header(&self) -> Option<String>

Render the Access-Control-Allow-Methods value as a comma-separated string.

Returns None if the field is not set.

pub fn allow_headers_header(&self) -> Option<String>

Render the Access-Control-Allow-Headers value as a comma-separated string.

Returns None if the field is not set.

pub fn expose_headers_header(&self) -> Option<String>

Render the Access-Control-Expose-Headers value as a comma-separated string.

Returns None if the field is not set.

Trait Implementations

impl Clone for CorsHeaders

fn clone(&self) -> CorsHeaders

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CorsHeaders

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

Formats the value using the given formatter.

impl Default for CorsHeaders

fn default() -> CorsHeaders

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CorsHeaders

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CorsHeaders

fn eq(&self, other: &CorsHeaders) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CorsHeaders

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CorsHeaders

impl StructuralPartialEq for CorsHeaders