Struct PermissionKey 

pub struct PermissionKey(String);

One validated dotted permission key.

Tuple Fields

0: String

Implementations

impl PermissionKey

pub fn parse(value: impl Into<String>) -> Result<Self, PermissionKeyError>

Parses a dotted permission key with an optional trailing wildcard.

Errors

Returns an error for empty or invalid segments and misplaced wildcards.

pub fn from_segments( segments: impl IntoIterator<Item = PermissionSegment>, ) -> Result<Self, PermissionKeyError>

Builds a permission key from validated non-wildcard segments.

Errors

Returns an error when no segments are supplied.

pub fn as_str(&self) -> &str

Returns the validated textual key.

pub fn child( &self, segment: &PermissionSegment, ) -> Result<Self, PermissionKeyError>

Appends one non-wildcard child segment.

Errors

Returns an error when this key ends in a wildcard.

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

Returns whether this key pattern matches other.

pub(super) fn specificity(&self) -> usize

pub(super) fn scopes(&self, key: &Self) -> bool

Trait Implementations

impl Clone for PermissionKey

fn clone(&self) -> PermissionKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PermissionKey

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

Formats the value using the given formatter.

impl Eq for PermissionKey

impl Hash for PermissionKey

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 PermissionKey

fn cmp(&self, other: &PermissionKey) -> 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 PermissionKey

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PermissionKey

fn partial_cmp(&self, other: &PermissionKey) -> 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 StructuralPartialEq for PermissionKey