Struct PendingAuthorization 

pub struct PendingAuthorization { /* private fields */ }

Everything a client must keep between sending the user away and handling the callback.

Redaction

Debug renders the secrets as … and the rest normally. The verifier and the state are both load-bearing — one redeems the code, the other proves the callback belongs to this request — and this is the value a client holds in memory across a user-visible redirect.

Implementations

impl PendingAuthorization

pub const fn state(&self) -> &State

The state this request issued, for comparing against the callback.

pub const fn code_verifier(&self) -> &CodeVerifier

The PKCE verifier to present when redeeming the code.

pub const fn resource(&self) -> &ResourceBinding

What the grant is bound to, and what the token request must repeat.

pub fn redirect_uri(&self) -> &str

The redirect URI the authorization request named.

pub const fn client_id(&self) -> &ClientId

The client this request was made as.

The token request has to name the same client, so a caller resuming the flow after the redirect needs it back from here rather than keeping a second copy alongside the pending value.

pub fn issuer(&self) -> &str

The issuer this flow is with.

Carried so the redemption step can check an iss response against something the client recorded when it started, rather than against a value read from the response it is trying to validate.

pub fn with_scope(self, scope: impl AsRef<str>) -> Self

This request, asking for scope (space-separated).

Omitted when not set: the authorization page has the client omit scope entirely when neither the challenge nor scopes_supported names any.

pub fn scope(&self) -> Option<&str>

The scope this request asks for, if any.

pub const fn with_iss_advertised(self, advertised: bool) -> Self

This request, recording that the server advertised iss support, so a response without one is refused.

pub const fn iss_advertised(&self) -> bool

Whether the server advertised iss support.

pub fn authorization_url( &self, endpoint: &str, method: ChallengeMethod, ) -> Result<Url, BeginError>

Render the URL to send the user to.

Appends to whatever query the endpoint already carries, because the endpoint came from a discovery document this crate does not control.

Errors

BeginError::Endpoint when the authorization endpoint is not a URL this crate can append to.

Trait Implementations

impl Clone for PendingAuthorization

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PendingAuthorization

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

Formats the value using the given formatter.