Enum AuthScope 

#[non_exhaustive]
pub enum AuthScope {
    Read,
    Admin,
}

Who is allowed to call a Capability.

#[non_exhaustive]: a future third tier (e.g. a scope narrower than Admin for a specific subsystem) should not be a downstream semver break. See Capability::auth_scope for the important caveat that this crate does not itself enforce this scope.

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.

Read

Read-only; safe for any authenticated caller.

Admin

Mutates controller state; callers should gate this behind an explicit admin/write permission.

Implementations

impl AuthScope

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

The scope’s wire/config representation ("read" or "admin").

Trait Implementations

impl Clone for AuthScope

fn clone(&self) -> AuthScope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthScope

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

Formats the value using the given formatter.

impl PartialEq for AuthScope

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for AuthScope

impl Eq for AuthScope

impl StructuralPartialEq for AuthScope