Struct AuthSession 

#[non_exhaustive]
pub struct AuthSession<S> {
    pub session_id: Uuid,
    pub subject: S,
    pub created_at: DateTime<Utc>,
    pub authenticated_at: DateTime<Utc>,
    pub expires_at: DateTime<Utc>,
}

An authenticated session, as handed to the app.

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.

session_id: Uuid

Session id. Safe to log; key per-session app data by it.

subject: S

Who the session belongs to.

created_at: DateTime<Utc>

When the session was created.

authenticated_at: DateTime<Utc>

When the subject last proved who they are (login or completed step-up).

expires_at: DateTime<Utc>

Absolute expiry.

Trait Implementations

impl<S: Clone> Clone for AuthSession<S>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for AuthSession<S>

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

Formats the value using the given formatter.

impl<S: Eq> Eq for AuthSession<S>

impl<A, S> FromRequestParts<A> for AuthSession<S>

where A: Send + Sync, S: Clone + Send + Sync + 'static,

Available on crate feature axum only.

Extracts the session the GuardLayer authenticated. Without the layer (or for a bypassed request) it rejects with 401 {"error":"not_authenticated"}.

S must match the guard’s subject type.

type Rejection = Response<Body>

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

fn from_request_parts( parts: &mut Parts, _state: &A, ) -> impl Future<Output = Result<Self, Self::Rejection>> + Send

Perform the extraction.

impl<S> OperationInput for AuthSession<S>

Available on crate feature aide only.

fn operation_input(_: &mut GenContext, operation: &mut Operation)

Modify the operation.

fn inferred_early_responses( _: &mut GenContext, _: &mut Operation, ) -> Vec<(Option<u16>, Response)>

Inferred early responses are used to document early returns for extractors, guards inside handlers. For example these could represent JSON parsing errors, authentication failures.

impl<A, S> OptionalFromRequestParts<A> for AuthSession<S>

where A: Send + Sync, S: Clone + Send + Sync + 'static,

Available on crate feature axum only.

Option<AuthSession<S>>: None when the layer did not authenticate the request, for handlers that serve both anonymous and signed-in clients.

type Rejection = !

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

fn from_request_parts( parts: &mut Parts, _state: &A, ) -> impl Future<Output = Result<Option<Self>, Self::Rejection>> + Send

Perform the extraction.

impl<S: PartialEq> PartialEq for AuthSession<S>

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

Equality operator ==.

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

Inequality operator !=.

impl<S: PartialEq> StructuralPartialEq for AuthSession<S>