Struct RoleBuilder

pub struct RoleBuilder { /* private fields */ }

Builder for creating roles with a fluent API.

Implementations

impl RoleBuilder

pub fn new() -> Self

Create a new role builder.

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

Set the role name.

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

Set the role description.

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

Add a permission to the role.

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

Add multiple permissions to the role.

pub fn allow<I, S>(self, resource: impl Into<String>, actions: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add permissions with fluent allow syntax.

Example

use role_system::role::RoleBuilder;
let role = RoleBuilder::new()
    .name("admin")
    .allow("users", ["create", "read", "update", "delete"])
    .allow("roles", ["read", "assign"])
    .build().unwrap();

pub fn deny<I, S>(self, resource: impl Into<String>, actions: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add permissions with deny semantics (creates negative conditions).

Example

use role_system::role::RoleBuilder;
let role = RoleBuilder::new()
    .name("restricted_admin")
    .allow("users", ["read", "update"])
    .deny("system", ["shutdown"])
    .build().unwrap();

pub fn allow_when<I, S, F>( self, resource: impl Into<String>, actions: I, condition: F, ) -> Self

where I: IntoIterator<Item = S>, S: Into<String>, F: Fn(&HashMap<String, String>) -> bool + Send + Sync + 'static + Clone,

Add permissions with conditional access.

Example

use role_system::role::RoleBuilder;
let role = RoleBuilder::new()
    .name("user")
    .allow_when("profile", ["update"], |ctx|
        ctx.get("user_id") == ctx.get("target_id"))
    .build().unwrap();

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

Add metadata to the role.

pub fn active(self, active: bool) -> Self

Set whether the role is active.

pub fn build(self) -> Result<Role>

Build the role.

Trait Implementations

impl Debug for RoleBuilder

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

Formats the value using the given formatter.

impl Default for RoleBuilder

fn default() -> RoleBuilder

Returns the “default value” for a type.