Enum Role 

pub enum Role {
    User,
    Reporter,
    Moderator,
    Admin,
}

Built-in roles ordered from least privileged to most privileged.

These roles give you a ready-to-use hierarchy for common applications. When used with crate::authz::access_policy::AccessPolicy::<Role, crate::groups::Group>::require_role_or_supervisor, a higher-privileged role can satisfy lower-role requirements.

Example

use webgates_core::authz::access_policy::AccessPolicy;
use webgates_core::groups::Group;
use webgates_core::roles::Role;

let moderator_or_higher =
    AccessPolicy::<Role, Group>::require_role_or_supervisor(Role::Moderator);
let admin_or_moderator = AccessPolicy::<Role, Group>::require_role(Role::Admin)
    .or_require_role(Role::Moderator);

assert!(!moderator_or_higher.denies_all());
assert!(!admin_or_moderator.denies_all());

Variants

User

Baseline role for regular users.

This is the default role assigned by Account::new(...) when you use the built-in Role type.

Reporter

Role for users who primarily need read-heavy or reporting access.

Moderator

Elevated role for moderation or operational workflows.

Admin

Highest built-in role.

Administrators typically have full access to protected operations.

Trait Implementations

impl Clone for Role

fn clone(&self) -> Role

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Role

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

Formats the value using the given formatter.

impl Default for Role

fn default() -> Role

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Role

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Role

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

Formats the value using the given formatter.

impl FromStr for Role

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Role, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl IntoEnumIterator for Role

type Iterator = RoleIter

fn iter() -> RoleIter

impl Ord for Role

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Role

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Role, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl AccessHierarchy for Role

impl Copy for Role

impl Eq for Role

impl StructuralPartialEq for Role