Struct Auth

pub struct Auth {
    pub user_id: i32,
    pub roles: HashSet<String>,
    pub permissions: HashSet<Permission>,
}

roles and permissions available to a User

use to control what users are and are not allowed to do

Fields

user_id: i32

roles: HashSet<String>

permissions: HashSet<Permission>

Implementations

impl Auth

pub fn has_permission(&self, permission: String) -> bool

does the user with the id self.user_id have the given permission

pub fn has_all_permissions(&self, perms: impl AsRef<[String]>) -> bool

does the user with the id self.user_id have all of the given perms

pub fn has_any_permission(&self, perms: impl AsRef<[String]>) -> bool

does the user with the id self.user_id have any of the given perms

pub fn has_role(&self, role: impl AsRef<str>) -> bool

does the user with the id self.user_id have the given role

pub fn has_all_roles(&self, roles: impl AsRef<[String]>) -> bool

does the user with the id self.user_id have all of the given roles

pub fn has_any_roles(&self, roles: impl AsRef<[String]>) -> bool

does the user with the id self.user_id have any of the given roles

Trait Implementations

impl Clone for Auth

fn clone(&self) -> Auth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Auth

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

Formats the value using the given formatter.

impl FromRequest for Auth

fn from_request( req: &HttpRequest, _payload: &mut Payload, ) -> <Self as FromRequest>::Future

extracts Auth from the given req

type Future = Ready<Result<Auth, <Auth as FromRequest>::Error>>

Future that resolves to a Self.

type Error = AuthError

The associated error which can be returned.

fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously.