Struct oxide_auth::endpoint::RefreshFlow

pub struct RefreshFlow<E, R> where
    E: Endpoint<R>,
    R: WebRequest,  { /* fields omitted */ }

Takes requests from clients to refresh their access tokens.

Methods

impl<E, R> RefreshFlow<E, R> where
    E: Endpoint<R>,
    R: WebRequest, 

pub fn prepare(endpoint: E) -> Result<Self, E::Error>

Wrap the endpoint if it supports handling refresh requests.

Also binds the endpoint to the particular WebRequest type through the type system. The endpoint needs to provide (return Some):

• a Registrar from registrar
• an Issuer from issuer_mut

Panics

Indirectly execute may panic when this flow is instantiated with an inconsistent endpoint, for details see the documentation of Endpoint and execute. For consistent endpoints, the panic is instead caught as an error here.

pub fn execute(&mut self, request: R) -> Result<R::Response, E::Error>

Use the checked endpoint to refresh a token.

Panics

When the registrar, authorizer, or issuer returned by the endpoint is suddenly None when previously it was Some(_).