Struct Scope 

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

A Scope is set of Permissions with an allocation-free representation and is cheaply copyable.

Implementations

impl Scope

pub const fn with_permissions(permissions: PermissionFlags) -> Self

Makes a Scope containing all Permissions in permissions.

pub const fn with_permission(permission: Permission) -> Self

Makes a Scope containing permission.

pub fn with_no_permissions() -> Self

Makes a Scope without permissions.

pub fn merge(self, other: Self) -> Self

Merges self with other returning a new Scope containing the union of the permissions of both scopes.

pub fn parse(input: &str) -> Self

Parses a Scope from input. Always succeeds, even when the string does not contain a syntactically valid scope but an empty Scope is returned when this occurs.

pub fn has_permission(&self, permission: Permission) -> bool

Checks if self contains permission.

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

Checks if self has at least all of the permissions of other.

pub fn count_permissions(&self) -> u32

Counts the number of permissions in self.

pub fn permissions(&self) -> impl Iterator<Item = Permission>

Returns an Iterator over the Permissions in self.

Trait Implementations

impl Clone for Scope

fn clone(&self) -> Scope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Scope

impl Debug for Scope

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

Formats the value using the given formatter.

impl Default for Scope

fn default() -> Self

Very explicitly, a default Scope has no permissions. This is important to avoid accidentally granting permissions that were not intended.

impl<'de> Deserialize<'de> for Scope

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Scope

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

Formats the value using the given formatter.

impl Eq for Scope

impl From<Option<Role>> for Scope

fn from(role: Option<Role>) -> Self

Converts to this type from the input type.

impl From<String> for Scope

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Vec<String>> for Scope

fn from(scope_names: Vec<String>) -> Self

Converts to this type from the input type.

impl Hash for Scope

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 Ord for Scope

fn cmp(&self, other: &Scope) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Scope

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

fn partial_cmp(&self, other: &Scope) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Scope

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Scope