Struct Scopes 

pub struct Scopes { /* private fields */ }

A set of scopes, kept sorted so one set always renders identically.

OAuth writes scopes as a space-delimited string, which is easy to get wrong by hand — an empty scope, a double space, or a duplicate all produce a string that looks fine and compares unequal.

Implementations

impl Scopes

pub fn new() -> Self

pub fn parse(raw: &str) -> Scopes

Parse the space-delimited form OAuth sends on the wire.

pub fn of<I, S>(scopes: I) -> Scopes

where I: IntoIterator<Item = S>, S: Into<String>,

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

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

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

pub fn covers(&self, required: &Scopes) -> bool

Whether this set covers everything required asks for.

The question an authorisation check actually asks: not “are these equal” but “is what I was granted enough”.

pub fn intersect(&self, allowed: &Scopes) -> Scopes

The scopes in this set that are also in allowed.

A client asking for more than it is registered for gets the intersection rather than a refusal, which is what most providers do — but the caller decides, because silently granting less than was asked for is worth knowing about.

pub fn beyond(&self, allowed: &Scopes) -> Scopes

Anything in this set that allowed does not contain.

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub fn iter(&self) -> impl Iterator<Item = &str>

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 From<&str> for Scopes

fn from(raw: &str) -> Scopes

Converts to this type from the input type.

impl PartialEq for Scopes

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Scopes