Struct DeviceAccessTokenRequest

pub struct DeviceAccessTokenRequest<'a, 'b, TR, EF>
where
    TR: TokenResponse,
    EF: ExtraDeviceAuthorizationFields,
{ /* private fields */ }

The request for a device access token from the authorization server.

See https://tools.ietf.org/html/rfc8628#section-3.4.

Implementations

impl<'a, 'b, TR, EF> DeviceAccessTokenRequest<'a, 'b, TR, EF>

where TR: TokenResponse, EF: ExtraDeviceAuthorizationFields,

pub fn add_extra_param<N, V>( self, name: N, value: V, ) -> DeviceAccessTokenRequest<'a, 'b, TR, EF>

where N: Into<Cow<'a, str>>, V: Into<Cow<'a, str>>,

Appends an extra param to the token request.

This method allows extensions to be used without direct support from this crate. If name conflicts with a parameter managed by this crate, the behavior is undefined. In particular, do not set parameters defined by RFC 6749 or RFC 7636.

Security Warning

Callers should follow the security recommendations for any OAuth2 extensions used with this function, which are beyond the scope of RFC 6749.

pub fn set_time_fn<'t, T>( self, time_fn: T, ) -> DeviceAccessTokenRequest<'a, 't, TR, EF>

where T: Fn() -> DateTime<Utc> + Send + Sync + 't,

Specifies a function for returning the current time.

This function is used while polling the authorization server.

pub fn set_max_backoff_interval( self, interval: Duration, ) -> DeviceAccessTokenRequest<'a, 'b, TR, EF>

Sets the upper limit of the sleep interval to use for polling the token endpoint when the HTTP client returns an error (e.g., in case of connection timeout).

pub fn request<C, S>( self, http_client: &C, sleep_fn: S, timeout: Option<Duration>, ) -> Result<TR, RequestTokenError<<C as SyncHttpClient>::Error, StandardErrorResponse<DeviceCodeErrorResponseType>>>

where C: SyncHttpClient, S: Fn(Duration),

Synchronously polls the authorization server for a response, waiting using a user defined sleep function.

pub fn request_async<'c, C, S, SF>( self, http_client: &'c C, sleep_fn: S, timeout: Option<Duration>, ) -> impl Future<Output = Result<TR, RequestTokenError<<C as AsyncHttpClient<'c>>::Error, StandardErrorResponse<DeviceCodeErrorResponseType>>>> + 'c

where DeviceAccessTokenRequest<'a, 'b, TR, EF>: 'c, C: AsyncHttpClient<'c>, S: Fn(Duration) -> SF + 'c, SF: Future<Output = ()>,

Asynchronously sends the request to the authorization server and awaits a response.

Trait Implementations

impl<'a, 'b, TR, EF> Clone for DeviceAccessTokenRequest<'a, 'b, TR, EF>

where TR: Clone + TokenResponse, EF: Clone + ExtraDeviceAuthorizationFields,

fn clone(&self) -> DeviceAccessTokenRequest<'a, 'b, TR, EF>

Returns a copy of the value.

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

Performs copy-assignment from source.