Enum ResponseMode

#[non_exhaustive]
pub enum ResponseMode {
    Query,
    Fragment,
}

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api and crate feature unstable-msc2965 only.

The mechanism to be used for returning authorization response parameters from the authorization endpoint.

The values are specified in OAuth 2.0 Multiple Response Type Encoding Practices.

This type can hold an arbitrary string. To build this with a custom value, convert it from a string with ::from() / .into(). To check for values that are not available as a documented variant here, use its string representation, obtained through .as_str().

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Query

Authorization Response parameters are encoded in the fragment added to the redirect_uri when redirecting back to the client.

Fragment

Authorization Response parameters are encoded in the query string added to the redirect_uri when redirecting back to the client.

Implementations

impl ResponseMode

pub fn as_str(&self) -> &str

Creates a string slice from this ResponseMode.

Trait Implementations

impl AsRef<str> for ResponseMode

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ResponseMode

fn clone(&self) -> ResponseMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseMode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponseMode

fn deserialize<D>( deserializer: D, ) -> Result<ResponseMode, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ResponseMode

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

Formats the value using the given formatter.

impl<T> From<T> for ResponseMode

where T: AsRef<str> + Into<Box<str>>,

fn from(s: T) -> ResponseMode

Converts to this type from the input type.

impl Ord for ResponseMode

fn cmp(&self, other: &ResponseMode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ResponseMode

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

fn partial_cmp(&self, other: &ResponseMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ResponseMode

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ResponseMode