Struct ScopeRequirement 

pub struct ScopeRequirement { /* private fields */ }

A set of required OAuth scopes for an operation.

All scopes in the requirement must be present in the token for access to be granted (AND semantics).

Implementations

impl ScopeRequirement

pub fn new() -> Self

Create an empty scope requirement (no scopes needed).

pub fn one(scope: impl Into<String>) -> Self

Create a scope requirement from a single scope.

pub fn all(scopes: impl IntoIterator<Item = impl Into<String>>) -> Self

Create a scope requirement from multiple scopes.

pub fn require(self, scope: impl Into<String>) -> Self

Add a required scope to this requirement.

pub fn check(&self, claims: &TokenClaims) -> Result<(), OAuthError>

Check if the given token claims satisfy this requirement.

Returns Ok(()) if all required scopes are present, or Err(OAuthError::InsufficientScope) with details about which scopes are missing.

pub fn check_with( &self, claims: &TokenClaims, matcher: &dyn ScopeMatcher, ) -> Result<(), OAuthError>

Check the requirement using a custom scope matcher.

pub fn required_scopes(&self) -> &HashSet<String>

Returns the required scopes.

pub fn is_empty(&self) -> bool

Returns true if no scopes are required.

Trait Implementations

impl Clone for ScopeRequirement

fn clone(&self) -> ScopeRequirement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScopeRequirement

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

Formats the value using the given formatter.

impl Default for ScopeRequirement

fn default() -> ScopeRequirement

Returns the “default value” for a type.