Struct Scopes 

pub struct Scopes { /* private fields */ }

An ordered set of resource scopes.

See the module-level documentation for allowed characters, ordering, and the roles scopes play.

Implementations

impl Scopes

pub fn empty() -> Self

Returns an empty set of scopes.

pub fn is_empty(&self) -> bool

Returns true if there are no scopes.

pub fn get(&self, key: &str) -> Option<&Scope>

Returns the scope with the given key, if it exists.

pub fn get_value(&self, key: &str) -> Option<&str>

Returns the value of the scope with the given key, if it exists.

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

Returns an iterator over all scopes.

pub fn push<V>(&mut self, key: &str, value: V) -> Result<(), InvalidScopeError>

where V: Display,

Pushes a new scope to the collection.

pub fn as_storage_path(&self) -> AsStoragePath<'_>

Returns a view that formats the scopes as path for storage.

This will serialize the scopes as {name}.{value}/..., which is intended to be used by backends to reference the object in a storage system. This becomes part of the storage path of an ObjectId.

pub fn as_api_path(&self) -> AsApiPath<'_>

Returns a view that formats the scopes as path for web API usage.

This will serialize the scopes as {name}={value};..., which is intended to be used by clients to format URL paths.

Trait Implementations

impl Clone for Scopes

fn clone(&self) -> Scopes

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 FromIterator<Scope> for Scopes

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = Scope>,

Creates a value from an iterator.

impl Hash for Scopes

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> IntoIterator for &'a Scopes

type IntoIter = Iter<'a, Scope>

Which kind of iterator are we turning this into?

type Item = &'a Scope

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Scopes

fn eq(&self, other: &Scopes) -> 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 Eq for Scopes

impl StructuralPartialEq for Scopes