Struct BrowserSessions 

pub struct BrowserSessions {
    lifetime: Duration,
    clock: Clock,
    inner: Mutex<Inner>,
}

Every browser session and ticket this server holds.

Each map holds at most one entry per account, or one per sign-in inside its grace, so the store is bounded by the number of accounts. Every call first removes what has run out: expired tickets, accounts past their deadline, sessions left holding none, and replaced ids past their grace.

Fields

lifetime: Duration

clock: Clock

inner: Mutex<Inner>

Implementations

impl BrowserSessions

pub fn new(lifetime: Duration) -> Self

An empty store whose sign-ins last lifetime, counted from each sign-in. Use does not extend it.

pub fn with_clock(lifetime: Duration, clock: Clock) -> Self

The same, reading the time from clock, for a test that ages the store without waiting.

pub fn lifetime(&self) -> Duration

How long a sign-in lasts.

pub fn now(&self) -> OffsetDateTime

The time this store reads.

fn inner(&self, now: OffsetDateTime) -> MutexGuard<'_, Inner>

pub fn mint(&self, account: &str) -> Minted

Mints a ticket for account, replacing any it already had.

The caller checks the e-stop and the account’s own agent token.

pub fn redeem(&self, ticket: &str, cookie: Option<&str>) -> Option<SignedIn>

Spends ticket and signs its account in to the browser that presented cookie, or to a new session when it presented none that is live.

The account’s deadline is now plus the lifetime. It leaves any other session, and the session it joins gets a new id. None when the ticket is unknown, used or expired, and then nothing changes.

The caller checks the host, Sec-Fetch-Site and the e-stop first, so a refused request leaves the ticket as it was.

pub fn browser(&self, cookie: &str) -> Option<Browser>

The session cookie names: its current id, or an id it replaced inside that id’s grace.

pub fn revoke_account(&self, account: &str)

Takes account out of its browser and drops its ticket, as an account’s deletion or erasure does.

pub fn revoke_all(&self)

Ends every session, replaced id and ticket, as the e-stop’s Revoke does. Nothing brings them back.

Trait Implementations

impl Debug for BrowserSessions

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

Formats the value using the given formatter.

impl Default for BrowserSessions

fn default() -> Self

Returns the “default value” for a type.