Struct AuthContext 

#[non_exhaustive]
pub struct AuthContext {
    pub user_id: UserId,
    pub session_id: Option<i64>,
    pub roles: Vec<String>,
    pub session_started_at: Option<UnixMillis>,
}

Who is calling: attached to a request by an Authenticator.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

user_id: UserId

The authenticated user.

session_id: Option<i64>

The session (token family) the request’s token belongs to; None for authenticators without sessions (e.g. a game’s API key).

roles: Vec<String>

The user’s roles (admin, a game’s own); empty for a normal player.

session_started_at: Option<UnixMillis>

When the session was started (the login); for “log in again first” checks.

Implementations

impl AuthContext

pub fn new(user_id: UserId) -> Self

A context for this user, without a session or roles.

pub fn with_session_started_at(self, at: UnixMillis) -> Self

The same context with the session’s start (login) time.

pub fn is_recent_login(&self, now: UnixMillis, max_age_ms: i64) -> bool

Whether the session was started (logged in) at most max_age_ms before now.

pub fn with_session(self, session_id: i64) -> Self

The same context with a session id.

pub fn with_roles(self, roles: Vec<String>) -> Self

The same context with these roles.

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

Whether the user has this role.

pub fn require_role(&self, role: &str) -> Result<(), AppError>

Ok if the user has this role, else 403 forbidden (for roles chosen at run time; the RequireRole extractor covers fixed ones).

Trait Implementations

impl Clone for AuthContext

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthContext

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

Formats the value using the given formatter.

impl Eq for AuthContext

impl<S: Send + Sync> FromRequestParts<S> for AuthContext

type Rejection = AppError

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_request_parts( parts: &mut Parts, _state: &S, ) -> Result<Self, Self::Rejection>

Perform the extraction.

impl<S: Send + Sync> OptionalFromRequestParts<S> for AuthContext

type Rejection = AppError

If the extractor fails, it will use this “rejection” type.

async fn from_request_parts( parts: &mut Parts, _state: &S, ) -> Result<Option<Self>, Self::Rejection>

Perform the extraction.

impl PartialEq for AuthContext

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AuthContext