Enum matrix_sdk::oidc::types::requests::Prompt

#[non_exhaustive]
pub enum Prompt {
    None,
    Login,
    Consent,
    SelectAccount,
    Create,
    Unknown(String),
}

Available on crate feature experimental-oidc only.

Value that specifies whether the Authorization Server prompts the End-User for reauthentication and consent.

Defined in OpenID Connect Core 1.0.

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.

None

The Authorization Server must not display any authentication or consent user interface pages.

Login

The Authorization Server should prompt the End-User for reauthentication.

Consent

The Authorization Server should prompt the End-User for consent before returning information to the Client.

SelectAccount

The Authorization Server should prompt the End-User to select a user account.

This enables an End-User who has multiple accounts at the Authorization Server to select amongst the multiple accounts that they might have current sessions for.

Create

The Authorization Server should prompt the End-User to create a user account.

Defined in Initiating User Registration via OpenID Connect.

Unknown(String)

An unknown value.

Trait Implementations

impl Clone for Prompt

fn clone(&self) -> Prompt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Prompt

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Prompt

where Prompt: FromStr, <Prompt as FromStr>::Err: Display,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Prompt

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

Formats the value using the given formatter.

impl FromStr for Prompt

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Prompt, <Prompt as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Prompt

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Prompt

fn cmp(&self, other: &Prompt) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Prompt

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

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

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

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

impl PartialOrd for Prompt

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Prompt

where Prompt: Display,

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 Prompt

impl StructuralPartialEq for Prompt