Struct JwtLocation

#[non_exhaustive]
pub struct JwtLocation {
    pub value_prefix: String,
    pub in: Option<In>,
}

Specifies a location to extract JWT from an API request.

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.

value_prefix: String

The value prefix. The value format is “value_prefix{token}” Only applies to “in” header type. Must be empty for “in” query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed.

For example, for “Authorization: Bearer {JWT}”, value_prefix=“Bearer “ with a space at the end.

in: Option<In>

Implementations

impl JwtLocation

pub fn set_value_prefix<T: Into<String>>(self, v: T) -> Self

Sets the value of value_prefix.

pub fn set_in<T: Into<Option<In>>>(self, v: T) -> Self

Sets the value of r#in.

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

The value of [r#in][crate::model::JwtLocation::r#in] if it holds a Header, None if the field is not set or holds a different branch.

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

The value of [r#in][crate::model::JwtLocation::r#in] if it holds a Query, None if the field is not set or holds a different branch.

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

The value of [r#in][crate::model::JwtLocation::r#in] if it holds a Cookie, None if the field is not set or holds a different branch.

pub fn set_header<T: Into<String>>(self, v: T) -> Self

Sets the value of [r#in][crate::model::JwtLocation::r#in] to hold a Header.

Note that all the setters affecting r#in are mutually exclusive.

pub fn set_query<T: Into<String>>(self, v: T) -> Self

Sets the value of [r#in][crate::model::JwtLocation::r#in] to hold a Query.

Note that all the setters affecting r#in are mutually exclusive.

pub fn set_cookie<T: Into<String>>(self, v: T) -> Self

Sets the value of [r#in][crate::model::JwtLocation::r#in] to hold a Cookie.

Note that all the setters affecting r#in are mutually exclusive.

Trait Implementations

impl Clone for JwtLocation

fn clone(&self) -> JwtLocation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JwtLocation

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

Formats the value using the given formatter.

impl Default for JwtLocation

fn default() -> JwtLocation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JwtLocation

where JwtLocation: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for JwtLocation

fn typename() -> &'static str

The typename of this message.

impl PartialEq for JwtLocation

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for JwtLocation