Struct Role

pub struct Role { /* private fields */ }

A role represents a collection of permissions that can be assigned to subjects.

Implementations

impl Role

pub fn new(name: impl Into<String>) -> Self

Create a new role with the given name.

pub fn with_id(id: impl Into<String>, name: impl Into<String>) -> Self

Create a new role with a specific ID.

pub fn id(&self) -> &str

Get the role’s unique identifier.

pub fn name(&self) -> &str

Get the role’s name.

pub fn with_description(self, description: impl Into<String>) -> Self

Set the role’s description.

pub fn description(&self) -> Option<&str>

Get the role’s description.

pub fn add_permission(self, permission: Permission) -> Self

Add a permission to this role.

pub fn add_permissions( self, permissions: impl IntoIterator<Item = Permission>, ) -> Self

Add multiple permissions to this role.

pub fn remove_permission(&mut self, permission: &Permission)

Remove a permission from this role.

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

Check if this role has a specific permission.

pub fn has_permission( &self, action: &str, resource_type: &str, context: &HashMap<String, String>, ) -> bool

Check if this role grants permission for an action on a resource type.

pub fn permissions(&self) -> &PermissionSet

Get all permissions granted by this role.

pub fn with_metadata( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Set metadata for this role.

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

Get metadata value for a key.

pub fn all_metadata(&self) -> &HashMap<String, String>

Get all metadata.

pub fn set_active(&mut self, active: bool)

Set whether this role is active.

pub fn is_active(&self) -> bool

Check if this role is active.

pub fn deactivate(self) -> Self

Deactivate this role.

pub fn merge_permissions(&mut self, other: &Role)

Merge permissions from another role into this one.

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.