Struct AuthorizationGrant

pub struct AuthorizationGrant {

    pub id: Ulid,
    pub stage: AuthorizationGrantStage,
    pub code: Option<AuthorizationCode>,
    pub client_id: Ulid,
    pub redirect_uri: Url,
    pub scope: Scope,
    pub state: Option<String>,
    pub nonce: Option<String>,
    pub max_age: Option<NonZeroU32>,
    pub response_mode: ResponseMode,
    pub response_type_id_token: bool,
    pub created_at: DateTime<Utc>,
    pub requires_consent: bool,
    pub login_hint: Option<String>,
}

Fields

id: Ulid

stage: AuthorizationGrantStage

code: Option<AuthorizationCode>

client_id: Ulid

redirect_uri: Url

scope: Scope

state: Option<String>

nonce: Option<String>

max_age: Option<NonZeroU32>

response_mode: ResponseMode

response_type_id_token: bool

created_at: DateTime<Utc>

requires_consent: bool

login_hint: Option<String>

Implementations

impl AuthorizationGrant

pub fn max_auth_time(&self) -> DateTime<Utc>

pub fn parse_login_hint(&self, homeserver: &str) -> LoginHint

pub fn exchange( self, exchanged_at: DateTime<Utc>, ) -> Result<Self, InvalidTransitionError>

Mark the authorization grant as exchanged.

Errors

Returns an error if the authorization grant is not Fulfilled.

pub fn fulfill( self, fulfilled_at: DateTime<Utc>, session: &Session, ) -> Result<Self, InvalidTransitionError>

Mark the authorization grant as fulfilled.

Errors

Returns an error if the authorization grant is not Pending.

pub fn cancel( self, canceld_at: DateTime<Utc>, ) -> Result<Self, InvalidTransitionError>

Mark the authorization grant as cancelled.

Errors

Returns an error if the authorization grant is not Pending.

TODO

This appears to be unused

Methods from Deref<Target = AuthorizationGrantStage>

pub fn is_pending(&self) -> bool

Returns true if the authorization grant stage is Pending.

pub fn is_fulfilled(&self) -> bool

Returns true if the authorization grant stage is Fulfilled.

pub fn is_exchanged(&self) -> bool

Returns true if the authorization grant stage is Exchanged.

Trait Implementations

impl Clone for AuthorizationGrant

fn clone(&self) -> AuthorizationGrant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AuthorizationGrant

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

Formats the value using the given formatter.

impl Deref for AuthorizationGrant

type Target = AuthorizationGrantStage

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl PartialEq for AuthorizationGrant

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AuthorizationGrant

impl StructuralPartialEq for AuthorizationGrant