Struct AuthorizeRule 

pub struct AuthorizeRule {
    pub roles: &'static [&'static str],
    pub permissions: &'static [&'static str],
}

One #[authorize] declaration on an endpoint.

Every rule on an endpoint must be satisfied (AND). Within a rule, a non-empty roles list means “the user has any of these roles” and a non-empty permissions list means “the user has any of these permissions”; the two dimensions are ANDed. Empty lists leave a dimension unconstrained, so a rule with both empty means “any authenticated user”.

Multiple values in one declaration (#[authorize(roles = ["admin", "auditor"])]) express alternatives; multiple #[authorize] attributes express requirements that all have to hold.

Fields

roles: &'static [&'static str]

Any-of role names; empty = no role constraint.

permissions: &'static [&'static str]

Any-of permission names; empty = no permission constraint.

Implementations

impl AuthorizeRule

pub const fn authenticated() -> AuthorizeRule

A rule that only requires a valid authenticated principal.

pub fn matches(&self, roles: &[String], permissions: &[String]) -> bool

Whether this rule is satisfied by the given claims.

The "authenticated" sentinel is accepted in roles for hand-written metadata; a rule with no constraints has the same meaning.

Trait Implementations

impl Clone for AuthorizeRule

fn clone(&self) -> AuthorizeRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AuthorizeRule

impl Debug for AuthorizeRule

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

Formats the value using the given formatter.

impl Eq for AuthorizeRule

impl PartialEq for AuthorizeRule

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for AuthorizeRule

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AuthorizeRule