Struct mas_data_model::oauth2::DeviceCodeGrant

pub struct DeviceCodeGrant {
    pub id: Ulid,
    pub state: DeviceCodeGrantState,
    pub client_id: Ulid,
    pub scope: Scope,
    pub user_code: String,
    pub device_code: String,
    pub created_at: DateTime<Utc>,
    pub expires_at: DateTime<Utc>,
    pub ip_address: Option<IpAddr>,
    pub user_agent: Option<UserAgent>,
}

Fields

id: Ulid

state: DeviceCodeGrantState

client_id: Ulid

The client ID which requested this device code grant.

scope: Scope

The scope which was requested by this device code grant.

user_code: String

The user code which was generated for this device code grant. This is the one that the user will enter into their client.

device_code: String

The device code which was generated for this device code grant. This is the one that the client will use to poll for an access token.

created_at: DateTime<Utc>

The time at which this device code grant was created.

expires_at: DateTime<Utc>

The time at which this device code grant will expire.

ip_address: Option<IpAddr>

The IP address of the client which requested this device code grant.

user_agent: Option<UserAgent>

The user agent used to request this device code grant.

Implementations

impl DeviceCodeGrant

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

Mark this device code grant as fulfilled, returning the updated grant.

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 the updated grant.

Errors

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

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

Mark this device code grant as exchanged, returning the updated grant.

Errors

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

Methods from Deref<Target = DeviceCodeGrantState>

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 DeviceCodeGrant

fn clone(&self) -> DeviceCodeGrant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceCodeGrant

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

Formats the value using the given formatter.

impl Deref for DeviceCodeGrant

type Target = DeviceCodeGrantState

The resulting type after dereferencing.

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

Dereferences the value.

impl PartialEq for DeviceCodeGrant

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

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 DeviceCodeGrant

impl StructuralPartialEq for DeviceCodeGrant