Skip to main content

DeviceFlow

Struct DeviceFlow 

Source
pub struct DeviceFlow { /* private fields */ }
Expand description

Manages a complete RFC 8628 device-flow OAuth session.

Provider-agnostic: supply the device-code URL and token URL for any provider that supports the Device Authorization Grant.

Implementations§

Source§

impl DeviceFlow

Source

pub fn new( client_id: impl Into<String>, scopes: Vec<String>, device_code_url: impl Into<String>, token_url: impl Into<String>, ) -> OAuthResult<Self>

Create a new device flow for the given OAuth app and provider endpoints.

  • device_code_url: the provider’s device-authorization endpoint
  • token_url: the provider’s token endpoint used during polling

Returns an error if the underlying TLS client cannot be constructed.

Source

pub async fn request_device_code(&self) -> OAuthResult<DeviceCodeResponse>

Step 1 — request a device code from the provider.

Returns the DeviceCodeResponse that you should present to the user (display user_code and verification_uri).

Source

pub async fn poll_for_token( &self, device_code: &DeviceCodeResponse, ) -> OAuthResult<DeviceTokenResponse>

Step 2 — poll the provider until the user has authorised the device.

Automatically respects the interval returned by step 1 and handles slow_down responses (which add 5 s to the current interval per spec).

Returns Ok(DeviceTokenResponse) once the user approves the request.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more