Struct KeySetStatus 

#[non_exhaustive]
pub struct KeySetStatus {
    pub keys: usize,
    pub jwks_uri: Option<String>,
    pub last_attempt: Option<SystemTime>,
    pub last_success: Option<SystemTime>,
    pub last_error: Option<RefreshError>,
}

A point-in-time view of the signing keys an crate::OAuthValidator holds, from crate::OAuthValidator::key_set_status.

Reading it does no I/O and never waits on a refresh in flight, so a readiness probe, a status page or a metrics scrape can call it as often as it likes. #[non_exhaustive]: read its fields, never build one; a field may be added in a minor release.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

keys: usize

How many usable verification keys are held.

jwks_uri: Option<String>

The JWKS URL in use: the configured jwks_uri, or the one discovered from the issuer’s metadata — None while it is still undiscovered. Redacted as RefreshError’s # Security note describes: any userinfo shows as ***@ and any query as ?***.

last_attempt: Option<SystemTime>

When the most recent refresh started, whether or not it has finished and however it ended; None before the first one.

last_success: Option<SystemTime>

When a refresh last succeeded (loaded a key set with at least one usable key); None if none ever has. A failed refresh leaves it — and the keys — as they were.

last_error: Option<RefreshError>

Why the most recent finished refresh failed; None if it succeeded or none has finished yet. Read RefreshError’s # Security note before exposing its Display publicly.

Implementations

impl KeySetStatus

pub fn is_ready(&self) -> bool

At least one usable key is held — see crate::OAuthValidator::is_ready.

Trait Implementations

impl Clone for KeySetStatus

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 KeySetStatus

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

Formats the value using the given formatter.

impl Default for KeySetStatus

fn default() -> Self

Returns the “default value” for a type.

impl Eq for KeySetStatus

impl PartialEq for KeySetStatus

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for KeySetStatus