Struct UserSession

pub struct UserSession<U, R = String, T = U> { /* private fields */ }

Role-based user sessions.

Implementations

impl<U, R, T> UserSession<U, R, T>

pub fn new(user_id: U, session_id: impl Into<Option<SessionId>>) -> Self

Creates a new instance with empty roles.

pub fn set_session_id(&mut self, session_id: SessionId)

Sets the session ID.

pub fn set_access_key_id(&mut self, access_key_id: AccessKeyId)

Sets the access key ID.

pub fn set_roles(&mut self, roles: impl Into<Vec<R>>)

Sets the user roles.

pub fn set_tenant_id(&mut self, tenant_id: T)

Sets the tenant ID.

pub fn user_id(&self) -> &U

Returns the user ID.

pub fn tenant_id(&self) -> Option<&T>

Returns the tenant ID.

pub fn session_id(&self) -> Option<&SessionId>

Returns the session ID.

pub fn access_key_id(&self) -> Option<&AccessKeyId>

Returns the access key ID.

pub fn roles(&self) -> &[R]

Returns the roles.

impl<U, R, T> UserSession<U, R, T>

where U: FromStr, R: FromStr, T: FromStr, <U as FromStr>::Err: Error + Send + 'static,

pub fn try_from_jwt_claims(claims: JwtClaims) -> Result<Self, Error>

Available on crate feature jwt only.

Attempts to construct an instance from a JwtClaims.

impl<U, T> UserSession<U, String, T>

pub fn is_superuser(&self) -> bool

Returns true if the user has a role of superuser.

pub fn is_user(&self) -> bool

Returns true if the user has a role of user.

pub fn is_guest(&self) -> bool

Returns true if the user has a role of guest.

pub fn is_agent(&self) -> bool

Returns true if the user has a role of agent.

pub fn is_admin(&self) -> bool

Returns true if the user has a role of admin.

pub fn is_worker(&self) -> bool

Returns true if the user has a role of worker.

pub fn is_auditor(&self) -> bool

Returns true if the user has a role of auditor.

pub fn has_user_role(&self) -> bool

Returns true if the user has one of the roles: superuser, user, admin, worker and auditor.

pub fn has_admin_role(&self) -> bool

Returns true if the user has a role of superuser or admin.

pub fn has_worker_role(&self) -> bool

Returns true if the user has a role of superuser or worker.

pub fn has_auditor_role(&self) -> bool

Returns true if the user has a role of superuser or auditor.

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

Returns true if the user has the specific role.

pub fn has_any_roles(&self, roles: &[&str]) -> bool

Returns true if the user has any of the specific roles.

pub fn has_all_roles(&self, roles: &[&str]) -> bool

Returns true if the user has all of the specific roles.

Trait Implementations

impl<U: Clone, R: Clone, T: Clone> Clone for UserSession<U, R, T>

fn clone(&self) -> UserSession<U, R, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<U: Debug, R: Debug, T: Debug> Debug for UserSession<U, R, T>

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

Formats the value using the given formatter.

impl<'de, U, R, T> Deserialize<'de> for UserSession<U, R, T>

where U: Deserialize<'de>, R: Deserialize<'de>, T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<U, R, T> Serialize for UserSession<U, R, T>

where U: Serialize, R: Serialize, T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.