Struct openid_client::client::device_flow_handle::DeviceFlowHandle

pub struct DeviceFlowHandle { /* private fields */ }

DeviceFlowHandle

Handle used for Device Grant

Implementations

impl DeviceFlowHandle

pub fn new( client: Client, response: DeviceAuthorizationResponse, extras: Option<DeviceAuthorizationExtras>, max_age: Option<u64>, ) -> Self

Creates a new Device Flow Handle

client - See Client response - DeviceAuthorizationResponse from the Device Authorization Endpoint extras - See DeviceAuthorizationExtras max_age - Maximum allowed age of the token

pub fn expires_at(&self) -> i64

Gets the timestamp in seconds of when the device code expires

pub fn expires_in(&self) -> i64

Gets the seconds in which the device code expires

pub fn expired(&self) -> bool

Gets wether the device code is expired or not

pub fn interval(&self) -> f64

Gets the polling interval

pub fn increase_interval(&mut self, by: f64)

Increase the interval by by seconds

pub fn client(&self) -> &Client

Gets the inner client

pub fn device_code(&self) -> &str

Gets the Device Code

pub fn user_code(&self) -> &str

Gets the User Code

pub fn verification_uri(&self) -> &str

Gets verification uri

pub fn verification_uri_complete(&self) -> Option<&String>

Gets the complete verification uri

pub async fn grant_async<T>( &mut self, http_client: &T, ) -> OidcReturnType<DeviceFlowGrantResponse>

where T: OidcHttpClient,

Device Flow Grant

Performs grant request at the token endpoint. This method will not poll itself. It is left to the implementor to create that logic.

See DeviceFlowGrantResponse for the possible responses that will be obtained from the grant.

Trait Implementations

impl Debug for DeviceFlowHandle

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

Formats the value using the given formatter.