Struct Identity 

pub struct Identity { /* private fields */ }

A handle to the current visitor’s identity.

Extract it in any handler. It is always available: an anonymous visitor simply has no id. Every method operates on the session, so the changes are persisted by the session plugin on the way out.

Implementations

impl Identity

pub fn id(&self) -> Option<String>

Who the visitor is, or None when anonymous.

pub fn is_authenticated(&self) -> bool

Whether anyone is logged in.

pub fn login(&self, id: impl Into<String>)

Record id as the logged-in visitor.

The session identifier is rotated first (see Session::rotate), so a server-side store mints a fresh record rather than promoting one an attacker may have planted. Session contents other than the identity are preserved, which is what keeps a pre-login cart or locale across the boundary. Call logout first if you would rather start empty.

pub fn logout(&self)

Log the visitor out and drop the whole session.

Everything goes, not just the identity keys: anything put in the session while signed in was put there for a signed-in visitor.

With a client-side store this clears the visitor’s copy but cannot revoke a copy taken beforehand, which stays valid until its signed deadline. Revocation needs server-side state.

pub fn logged_in_at(&self) -> Option<i64>

When the visitor logged in, as Unix seconds.

pub fn last_seen_at(&self) -> Option<i64>

When the visitor was last seen, as Unix seconds.

Only maintained when Identities::visit_deadline is set, and only written periodically rather than on every request. See that method for why.

Trait Implementations

impl Clone for Identity

fn clone(&self) -> Identity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Identity

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

Formats the value using the given formatter.

impl FromCallParts for Identity

fn from_call_parts<'life0, 'async_trait>( call: &'life0 mut Call, ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Build Self from a mutable borrow of the call, or return an Error (which the handler renders as the response).