Enum DeviceCodeGrantState 

pub enum DeviceCodeGrantState {
    Pending,
    Fulfilled {
        browser_session_id: Ulid,
        fulfilled_at: DateTime<Utc>,
    },
    Rejected {
        browser_session_id: Ulid,
        rejected_at: DateTime<Utc>,
    },
    Exchanged {
        browser_session_id: Ulid,
        fulfilled_at: DateTime<Utc>,
        exchanged_at: DateTime<Utc>,
        session_id: Ulid,
    },
}

Variants

Pending

The device code grant is pending.

Fulfilled

The device code grant has been fulfilled by a user.

Fields

browser_session_id: Ulid

The browser session which was used to complete this device code grant.

fulfilled_at: DateTime<Utc>

The time at which this device code grant was fulfilled.

Rejected

The device code grant has been rejected by a user.

Fields

browser_session_id: Ulid

The browser session which was used to reject this device code grant.

rejected_at: DateTime<Utc>

The time at which this device code grant was rejected.

Exchanged

The device code grant was exchanged for an access token.

Fields

browser_session_id: Ulid

The browser session which was used to exchange this device code grant.

fulfilled_at: DateTime<Utc>

The time at which the device code grant was fulfilled.

exchanged_at: DateTime<Utc>

The time at which this device code grant was exchanged.

session_id: Ulid

The OAuth 2.0 session ID which was created by this device code grant.

Implementations

impl DeviceCodeGrantState

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

Mark this device code grant as fulfilled, returning a new state.

Errors

Returns an error if the device code grant is not in the Pending state.

pub fn reject( self, browser_session: &BrowserSession, rejected_at: DateTime<Utc>, ) -> Result<Self, InvalidTransitionError>

Mark this device code grant as rejected, returning a new state.

Errors

Returns an error if the device code grant is not in the Pending state.

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

Mark this device code grant as exchanged, returning a new state.

Errors

Returns an error if the device code grant is not in the Fulfilled state.

pub fn is_pending(&self) -> bool

Returns true if the device code grant state is Pending.

pub fn is_fulfilled(&self) -> bool

Returns true if the device code grant state is Fulfilled.

pub fn is_rejected(&self) -> bool

Returns true if the device code grant state is Rejected.

pub fn is_exchanged(&self) -> bool

Returns true if the device code grant state is Exchanged.

Trait Implementations

impl Clone for DeviceCodeGrantState

fn clone(&self) -> DeviceCodeGrantState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceCodeGrantState

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

Formats the value using the given formatter.

impl PartialEq for DeviceCodeGrantState

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

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 DeviceCodeGrantState

impl StructuralPartialEq for DeviceCodeGrantState