Enum ProblemKind 

#[non_exhaustive]
pub enum ProblemKind {
    MissingRequired,
    InvalidUrl,
    InsecureHttp,
    BlankRequiredScope,
    MultiWordScope,
    InvalidScopeToken,
    EmptyListEntry,
    NoRequiredScope,
    EmptyScopeClaims,
    BadAlgorithm,
    NoAlgorithms,
    LeewayTooLarge,
    TokenAgeOutOfRange,
    InvalidRequiredClaim,
    EnvLoad,
    EnvParse,
    Other,
}

What kind of problem a ConfigProblem is, so a caller can react to it — or write its own sentence for it — without matching the crate’s prose.

#[non_exhaustive]: a new kind is an additive change, so match with a wildcard arm. Every problem OAuthConfig::resolve and the env loader find has a specific kind; Other is what a problem built from a plain String (an application loader’s own) gets.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

MissingRequired

A required setting is empty: issuer, resource, or both audience and audiences.

InvalidUrl

A URL setting (issuer, resource, jwks_uri) failed a check_url check: not an absolute http(s) URL, a query or fragment in an identifier (issuer, resource), leading or trailing whitespace, or a control or non-ASCII character.

InsecureHttp

A plain-http URL on a non-loopback host without allow_insecure_http.

BlankRequiredScope

required_scope, or an entry of required_scopes, is blank.

MultiWordScope

required_scope, or an entry of required_scopes, holds more than one scope (whitespace inside it).

InvalidScopeToken

A required or advertised scope is not an RFC 6749 §3.3 scope-token.

EmptyListEntry

A list setting (audiences, scopes_supported, principal_claims, allowed_client_ids) has a blank entry.

NoRequiredScope

No required scope is configured, require_at_jwt is off and allow_unscoped_tokens is not set.

EmptyScopeClaims

scope_claims is empty or has a blank entry.

BadAlgorithm

algorithms has an entry that is unknown or refused (HMAC, none).

NoAlgorithms

algorithms is empty.

LeewayTooLarge

leeway_secs is over MAX_LEEWAY_SECS.

TokenAgeOutOfRange

max_token_age_secs is 0 or over MAX_TOKEN_AGE_SECS.

InvalidRequiredClaim

A required_claims entry has a blank name, names a claim this crate already checks (iss, aud, exp, nbf, iat, cnf), or requires a value other than a string, number or boolean — or, from the env loader, the REQUIRED_CLAIMS JSON names one claim twice.

EnvLoad

The env loader could not read a variable or its _FILE (both set, an unreadable, empty, oversized or not-a-regular file).

EnvParse

The env loader read a value it could not parse (a bool other than "true"/"false", a non-integer leeway_secs or max_token_age_secs, a REQUIRED_CLAIMS that is not valid JSON or not a JSON object).

Other

Anything else, including every problem converted from a String.

Implementations

impl ProblemKind

pub fn as_str(self) -> &'static str

A stable, lowercase snake_case label for the kind ("missing_required", "invalid_url", …), for logs and metrics. Unlike a problem’s message, it does not change between releases for an existing kind.

Trait Implementations

impl Clone for ProblemKind

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ProblemKind

impl Debug for ProblemKind

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

Formats the value using the given formatter.

impl Display for ProblemKind

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

Formats the value using the given formatter.

impl Eq for ProblemKind

impl Hash for ProblemKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ProblemKind

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ProblemKind