Struct rocket_cors::Origins

pub struct Origins {
    pub allow_null: bool,
    pub exact: Option<HashSet<String>>,
    pub regex: Option<HashSet<String>>,
}

Origins that are allowed to make CORS requests.

An origin is defined according to the defined syntax.

Origins can be specified as an exact match or using regex.

These Origins are specified as logical ORs. That is, if any of the origins match, the entire request is considered to be valid.

Exact matches are matched exactly with the ASCII Serialization of the origin.

Regular expressions are tested for matches against the ASCII Serialization of the origin.

Opaque Origins

The specification defines an Opaque Origin as one that cannot be recreated. You can refer to the source code for the url::Url::origin method to see how an Opaque Origin is determined. Examples of Opaque origins might include schemes like file:// or Browser specific schemes like "moz-extension:// or chrome-extension://.

Opaque Origins cannot be matched exactly. You must use Regex to match Opaque Origins. If you attempt to create Cors from CorsOptions, you will get an error.

Warning about Regex expressions

By default, regex expressions are unanchored.

This means that if the regex does not start with ^ or \A, or end with $ or \z, then it is permitted to match anywhere in the text. You are encouraged to use the anchors when crafting your Regex expressions.

Fields

allow_null: bool

Whether null origins are accepted

exact: Option<HashSet<String>>

Origins that must be matched exactly as provided.

These must be valid URL strings that will be parsed and validated when creating Cors.

Exact matches are matched exactly with the ASCII Serialization of the origin.

Opaque Origins

The specification defines an Opaque Origin as one that cannot be recreated. You can refer to the source code for the url::Url::origin method to see how an Opaque Origin is determined. Examples of Opaque origins might include schemes like file:// or Browser specific schemes like "moz-extension:// or chrome-extension://.

Opaque Origins cannot be matched exactly. You must use Regex to match Opaque Origins. If you attempt to create Cors from CorsOptions, you will get an error.

regex: Option<HashSet<String>>

Origins that will be matched via any regex in this list.

These must be valid Regex that will be parsed and validated when creating Cors.

The regex will be matched according to the ASCII serialization of the incoming Origin.

For more information on the syntax of Regex in Rust, see the documentation.

Regular expressions are tested for matches against the ASCII Serialization of the origin.

Warning about Regex expressions

By default, regex expressions are unanchored.

Trait Implementations

impl Clone for Origins

fn clone(&self) -> Origins

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Origins

fn default() -> Origins

Returns the "default value" for a type.

impl Eq for Origins

impl PartialEq<Origins> for Origins

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Debug for Origins

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

Formats the value using the given formatter.

impl StructuralPartialEq for Origins

impl StructuralEq for Origins

impl Serialize for Origins

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Origins where
    Origins: Default, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.