Skip to main content

DeviceFlow

Struct DeviceFlow 

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

Runs the device flow: start_device_flow, show the code, then complete_login.

Implementations§

Source§

impl DeviceFlow

Source

pub fn new(config: AuthConfig) -> Result<Self, AuthError>

A flow on the real clock.

Source

pub fn with_time( config: AuthConfig, clock: Arc<dyn Clock>, sleeper: Arc<dyn Sleeper>, ) -> Result<Self, AuthError>

A flow with an injected clock and sleep (tests).

Source

pub async fn start_device_flow(&self) -> Result<DeviceCode, AuthError>

POST {auth_base}/device_authorization (AC1).

Source

pub async fn poll( &self, code: &DeviceCode, interval: Duration, ) -> Result<PollOutcome, AuthError>

One POST {auth_base}/token for code (AC2). A transport error is “not yet” (the live API dropped one poll, see the spec’s edge cases).

Source

pub async fn wait_for_session( &self, code: &DeviceCode, ) -> Result<Session, AuthError>

Polls until the user approves, the code expires or is denied (AC2), and builds the session from the token response (AC3).

Source

pub async fn complete_login( &self, code: &DeviceCode, store: &dyn SessionStore, ) -> Result<Login, AuthError>

wait_for_session, one refresh under the PKCE client (AC19), then saves the session to store. When that refresh fails for any reason, the grant’s session is saved as is. Nothing is stored when the login fails.

Trait Implementations§

Source§

impl Debug for DeviceFlow

Source§

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

Formats the value using the given formatter. Read more

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<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