Struct CorsPolicy 

#[non_exhaustive]
pub struct CorsPolicy {
    pub allow_credentials: Option<bool>,
    pub allow_headers: Vec<String>,
    pub allow_methods: Vec<String>,
    pub allow_origin_regexes: Vec<String>,
    pub allow_origins: Vec<String>,
    pub disabled: Option<bool>,
    pub expose_headers: Vec<String>,
    pub max_age: Option<i32>,
    /* private fields */
}

Available on crate features region-url-maps or url-maps only.

The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard.

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_credentials: Option<bool>

In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header.

Default is false.

allow_headers: Vec<String>

Specifies the content for the Access-Control-Allow-Headers header.

allow_methods: Vec<String>

Specifies the content for the Access-Control-Allow-Methods header.

allow_origin_regexes: Vec<String>

Specifies a regular expression that matches allowed origins. For more information, see regular expression syntax.

An origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes.

Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

allow_origins: Vec<String>

Specifies the list of origins that is allowed to do CORS requests.

An origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes.

disabled: Option<bool>

If true, disables the CORS policy. The default value is false, which indicates that the CORS policy is in effect.

expose_headers: Vec<String>

Specifies the content for the Access-Control-Expose-Headers header.

max_age: Option<i32>

Specifies how long results of a preflight request can be cached in seconds. This field translates to the Access-Control-Max-Age header.

Implementations

impl CorsPolicy

pub fn new() -> Self

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

where T: Into<bool>,

Sets the value of allow_credentials.

Example

let x = CorsPolicy::new().set_allow_credentials(true);

pub fn set_or_clear_allow_credentials<T>(self, v: Option<T>) -> Self

where T: Into<bool>,

Sets or clears the value of allow_credentials.

Example

let x = CorsPolicy::new().set_or_clear_allow_credentials(Some(false));
let x = CorsPolicy::new().set_or_clear_allow_credentials(None::<bool>);

pub fn set_allow_headers<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of allow_headers.

Example

let x = CorsPolicy::new().set_allow_headers(["a", "b", "c"]);

pub fn set_allow_methods<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of allow_methods.

Example

let x = CorsPolicy::new().set_allow_methods(["a", "b", "c"]);

pub fn set_allow_origin_regexes<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of allow_origin_regexes.

Example

let x = CorsPolicy::new().set_allow_origin_regexes(["a", "b", "c"]);

pub fn set_allow_origins<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of allow_origins.

Example

let x = CorsPolicy::new().set_allow_origins(["a", "b", "c"]);

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

where T: Into<bool>,

Sets the value of disabled.

Example

let x = CorsPolicy::new().set_disabled(true);

pub fn set_or_clear_disabled<T>(self, v: Option<T>) -> Self

where T: Into<bool>,

Sets or clears the value of disabled.

Example

let x = CorsPolicy::new().set_or_clear_disabled(Some(false));
let x = CorsPolicy::new().set_or_clear_disabled(None::<bool>);

pub fn set_expose_headers<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of expose_headers.

Example

let x = CorsPolicy::new().set_expose_headers(["a", "b", "c"]);

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

where T: Into<i32>,

Sets the value of max_age.

Example

let x = CorsPolicy::new().set_max_age(42);

pub fn set_or_clear_max_age<T>(self, v: Option<T>) -> Self

where T: Into<i32>,

Sets or clears the value of max_age.

Example

let x = CorsPolicy::new().set_or_clear_max_age(Some(42));
let x = CorsPolicy::new().set_or_clear_max_age(None::<i32>);

Trait Implementations

impl Clone for CorsPolicy

fn clone(&self) -> CorsPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CorsPolicy

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

Formats the value using the given formatter.

impl Default for CorsPolicy

fn default() -> CorsPolicy

Returns the “default value” for a type.

impl Message for CorsPolicy

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CorsPolicy

fn eq(&self, other: &CorsPolicy) -> 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 StructuralPartialEq for CorsPolicy