Struct Permission 

pub struct Permission { /* private fields */ }

A permission represents an action that can be performed on a resource type.

Permissions follow the format “action:resource” or “action:resource:instance” Examples:

• “read:documents” - Read any document
• “read:documents:doc123” - Read specific document doc123
• “admin:users” - Admin access to users
• “admin:users:user456” - Admin access to specific user

Special permissions:

• “:” grants all permissions (super admin)
• “action:*” grants all actions on any resource
• “*:resource” grants any action on a specific resource
• “action:resource:*” grants action on any instance of resource

Implementations

impl Permission

pub fn new( action: impl Into<String>, resource_type: impl Into<String>, ) -> Permission

Create a new permission for an action on a resource type.

pub fn try_new( action: impl Into<String>, resource_type: impl Into<String>, ) -> Result<Permission, Error>

Try to create a new permission, returning an error if validation fails.

pub fn with_instance( action: impl Into<String>, resource_type: impl Into<String>, instance: impl Into<String>, ) -> Permission

Create a new permission for an action on a specific resource instance.

pub fn with_condition<F>( action: impl Into<String>, resource_type: impl Into<String>, condition: F, ) -> Permission

where F: Fn(&HashMap<String, String>) -> bool + Send + Sync + 'static,

Create a permission with a conditional validator.

pub fn with_instance_and_condition<F>( action: impl Into<String>, resource_type: impl Into<String>, instance: impl Into<String>, condition: F, ) -> Permission

where F: Fn(&HashMap<String, String>) -> bool + Send + Sync + 'static,

Create a permission with both instance and condition.

pub fn wildcard(resource_type: impl Into<String>) -> Permission

Create a wildcard permission that grants access to all actions on a resource type.

pub fn super_admin() -> Permission

Create a super-admin permission that grants access to everything.

pub fn with_context( resource_type: impl Into<String>, action: impl Into<String>, context: Option<impl Into<String>>, ) -> Permission

Create a permission with enhanced context awareness.

Example

use role_system::permission::Permission;
let perm = Permission::with_context("users", "read", Some("own_data"));

pub fn with_scope( resource_type: impl Into<String>, action: impl Into<String>, scopes: Vec<impl Into<String>>, ) -> Vec<Permission>

Create a permission with multiple scopes/actions.

Example

use role_system::permission::Permission;
let perms = Permission::with_scope("users", "read", vec!["profile", "preferences"]);

pub fn conditional( resource_type: impl Into<String>, action: impl Into<String>, ) -> ConditionalPermissionBuilder

Create a conditional permission that depends on context.

Example

use role_system::permission::Permission;
let perm = Permission::conditional("users", "update")
    .when(|context| context.get("user_id") == context.get("target_id"));

pub fn action(&self) -> &str

Get the action this permission grants.

pub fn resource_type(&self) -> &str

Get the resource type this permission applies to.

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

Get the specific instance this permission applies to, if any.

pub fn matches(&self, action: &str, resource_type: &str) -> bool

Check if this permission matches the given action and resource type. For backward compatibility, this doesn’t consider instances.

pub fn matches_with_instance( &self, action: &str, resource_type: &str, instance: Option<&str>, ) -> bool

Check if this permission matches the given action, resource type, and optional instance.

pub fn implies(&self, other: &Permission) -> bool

Check if this permission implies another permission. A permission implies another if it grants equal or greater access.

Examples:

• “read:documents” implies “read:documents:doc123”
• “admin:*” implies “admin:users”
• “:” implies any permission
• “read:documents:*” implies “read:documents:doc123”

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

Check if this permission is granted given the context.

pub fn parse(permission_str: &str) -> Result<Permission, Error>

Parse a permission from a string format like “action:resource_type” or “action:resource_type:instance”.

Trait Implementations

impl Clone for Permission

fn clone(&self) -> Permission

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Permission

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Permission

fn deserialize<__D>( __deserializer: __D, ) -> Result<Permission, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Permission

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

Formats the value using the given formatter.

impl FromStr for Permission

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Permission, Error>

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

impl Hash for Permission

fn hash<H>(&self, state: &mut H)

where H: Hasher,

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 Permission

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Permission