Struct Scopes 

pub struct Scopes(/* private fields */);

What a token is allowed to do.

A plain list of strings, compared exactly. It is deliberately not an enum and deliberately not tied to any other package: an application names its own scopes, and a framework that ships a fixed vocabulary is a framework you fight the first time you add a feature.

Implementations

impl Scopes

pub fn new() -> Self

No scopes at all — a token that can do nothing.

pub fn any() -> Self

The wildcard: everything this user can do.

Sanctum’s default, and the right one for a first-party mobile app that is simply the user on another device.

pub fn push(&mut self, scope: impl Into<String>)

Add one scope, ignoring a repeat.

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

Add one scope, for chaining: Scopes::new().with("posts:read").

pub fn can(&self, scope: &str) -> bool

Whether this list grants scope.

The match is exact, apart from the wildcard. posts:write does not grant posts:writeextra and does not grant posts:write:all: a prefix match here would mean that adding a narrower-sounding scope later silently hands it to every token that already held the shorter one.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn iter(&self) -> Iter<'_, String>

pub fn as_slice(&self) -> &[String]

Trait Implementations

impl Clone for Scopes

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 Scopes

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

Formats the value using the given formatter.

impl Default for Scopes

fn default() -> Self

Returns the “default value” for a type.

impl Display for Scopes

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

Formats the value using the given formatter.

impl Eq for Scopes

impl<S: Into<String>> FromIterator<S> for Scopes

fn from_iter<I: IntoIterator<Item = S>>(iter: I) -> Self

Creates a value from an iterator.

impl PartialEq for Scopes

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Scopes