Struct Role 

pub struct Role { /* private fields */ }

A set of access permissions for resources.

Roles provide an intermediary for assigning access permissions to users by managing permission sets. Separete sets can be provided for specific resources, all other resources, and requests that do not operate on resources.

Currently, roles are given names and are defined in [Config::auth_roles][crate::daemon::config::Config::auth_roles] and referenced by authorization providers through those names.

Implementations

impl Role

pub fn admin() -> Self

Creates the special admin role.

This role allows all access to everything.

pub fn readwrite() -> Self

Creates the default read-write role.

This role uses PermissionSet::READWRITE for everything.

pub fn readonly() -> Self

Creates the default read-only role.

This role uses PermissionSet::READONLY for everything.

pub fn testbed() -> Self

Creates the special testbed role.

This role uses PermissionSet::TESTBED for everything.

pub fn anonymous() -> Self

Creates the anonymous special role.

This role allows nothing.

pub fn simple(permissions: PermissionSet) -> Self

Creates a role that uses the provided permission set for all access.

pub fn with_resources( permissions: PermissionSet, resources: impl IntoIterator<Item = MyHandle>, ) -> Self

Creates a role that uses the provided set for the given resources.

The role will allow access with the set to non-resource requests and all resources provided. Access to all other resources will be denied.

pub fn complex( none: PermissionSet, any: PermissionSet, resources: HashMap<MyHandle, PermissionSet>, ) -> Self

Creates a comples role.

The permission set none will be used for non-resource requests. The resources hash map contains special permission sets for the provided resources. The any set will be used for all resources not mentioned in the hash map.

pub fn is_allowed( &self, permission: Permission, resource: Option<&MyHandle>, ) -> bool

Returns whether access is allowed.

The method whether the role allows access with the provided permission to the provided resource. If the resource is None, access for non-resource requests is checked.

Returns true if access is allowed or false if not.

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<'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 Eq for Role

impl PartialEq for Role

fn eq(&self, other: &Role) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Role