Enum RUserRole 

pub enum RUserRole {
    User,
    Premium,
    Admin,
}

User role for authorization decisions.

Defines the access level and capabilities of a user.

Hierarchy

Role	Premium Access	Admin Access
User	No	No
Premium	Yes	No
Admin	Yes	Yes

Default

The default role is RUserRole::User.

Examples

use revelation_user::RUserRole;

// Default role
let role = RUserRole::default();
assert_eq!(role, RUserRole::User);

// Check access levels
assert!(!RUserRole::User.is_premium());
assert!(RUserRole::Premium.is_premium());
assert!(RUserRole::Admin.is_premium()); // Admins have premium
assert!(RUserRole::Admin.is_admin());

Serialization

Roles serialize to lowercase snake_case:

use revelation_user::RUserRole;

assert_eq!(serde_json::to_string(&RUserRole::User).unwrap(), "\"user\"");
assert_eq!(
    serde_json::to_string(&RUserRole::Premium).unwrap(),
    "\"premium\""
);
assert_eq!(
    serde_json::to_string(&RUserRole::Admin).unwrap(),
    "\"admin\""
);

Variants

User

Regular user with basic access.

This is the default role for new users.

Premium

Premium user with access to premium features.

Includes all User capabilities plus premium content.

Admin

Administrator with full access.

Has all Premium capabilities plus admin functions.

Implementations

impl RUserRole

pub const fn is_admin(&self) -> bool

Check if this role has admin privileges.

Only RUserRole::Admin returns true.

Examples

use revelation_user::RUserRole;

assert!(RUserRole::Admin.is_admin());
assert!(!RUserRole::Premium.is_admin());
assert!(!RUserRole::User.is_admin());

pub const fn is_premium(&self) -> bool

Check if this role has premium access.

Both RUserRole::Premium and RUserRole::Admin return true.

Examples

use revelation_user::RUserRole;

assert!(RUserRole::Admin.is_premium());
assert!(RUserRole::Premium.is_premium());
assert!(!RUserRole::User.is_premium());

pub const fn is_user(&self) -> bool

Check if this is a regular user role.

Only RUserRole::User returns true.

Examples

use revelation_user::RUserRole;

assert!(RUserRole::User.is_user());
assert!(!RUserRole::Premium.is_user());
assert!(!RUserRole::Admin.is_user());

pub const fn as_str(&self) -> &'static str

Returns the role as a lowercase string.

Examples

use revelation_user::RUserRole;

assert_eq!(RUserRole::User.as_str(), "user");
assert_eq!(RUserRole::Premium.as_str(), "premium");
assert_eq!(RUserRole::Admin.as_str(), "admin");

Trait Implementations

impl Clone for RUserRole

fn clone(&self) -> RUserRole

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RUserRole

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

Formats the value using the given formatter.

impl Default for RUserRole

fn default() -> RUserRole

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RUserRole

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RUserRole

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

Formats the value using the given formatter.

impl Hash for RUserRole

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 PartialEq for RUserRole

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

Implementation of Role trait for permission-based access control.

Permission Mapping

Role	Permissions
User	READ, API_ACCESS
Premium	READ, WRITE, API_ACCESS, PREMIUM, EXPORT
Admin	All permissions

Examples

use revelation_user::{Permissions, RUserRole, Role};

let admin = RUserRole::Admin;
assert!(admin.can(Permissions::MANAGE_USERS));
assert!(admin.can_all(Permissions::all()));

let premium = RUserRole::Premium;
assert!(premium.can(Permissions::PREMIUM));
assert!(premium.can(Permissions::EXPORT));
assert!(!premium.can(Permissions::ADMIN));

fn permissions(&self) -> Permissions

Get the permissions associated with this role.

fn name(&self) -> &'static str

Get the role name for display/logging.

fn can(&self, permission: Permissions) -> bool

Check if this role has the specified permission.

fn can_all(&self, permissions: Permissions) -> bool

Check if this role has all the specified permissions.

fn can_any(&self, permissions: Permissions) -> bool

Check if this role has any of the specified permissions.

fn is_admin(&self) -> bool

Check if this role is an admin role.

fn is_premium(&self) -> bool

Check if this role has premium access.

impl Serialize for RUserRole

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for RUserRole

impl Eq for RUserRole

impl StructuralPartialEq for RUserRole