# Struct actix_session::config::BrowserSession

source ·

    pub struct BrowserSession { /* private fields */ }

Expand description

A session lifecycle strategy where the session cookie expires when the browser’s current session ends.

When does a browser session end? It depends on the browser. Chrome, for example, will often continue running in the background when the browser is closed—session cookies are not deleted and they will still be available when the browser is opened again. Check the documentation of the browsers you are targeting for up-to-date information.

Due to its `Into<SessionLifecycle>` implementation, a `BrowserSession` can be passed directly to `SessionMiddlewareBuilder::session_lifecycle()`.

## Implementations§

source §

### impl BrowserSession

source

#### pub fn state_ttl(self, ttl: Duration) -> Self

Sets a time-to-live (TTL) when storing the session state in the storage backend.

We do not want to store session states indefinitely, otherwise we will inevitably run out of storage by holding on to the state of countless abandoned or expired sessions!

We are dealing with the lifecycle of two uncorrelated object here: the session cookie and the session state. It is not a big issue if the session state outlives the cookie— we are wasting some space in the backend storage, but it will be cleaned up eventually. What happens, instead, if the cookie outlives the session state? A new session starts— e.g. if sessions are being used for authentication, the user is de-facto logged out.

It is not possible to predict with certainty how long a browser session is going to last—you need to provide a reasonable upper bound. You do so via `state_ttl`—it dictates what TTL should be used for session state when the lifecycle of the session cookie is tied to the browser session length. `SessionMiddleware` will default to 1 day if `state_ttl` is left unspecified.

You can mitigate the risk of the session cookie outliving the session state by specifying a more aggressive state TTL extension policy - check out `BrowserSession::state_ttl_extension_policy` for more details.

source

#### pub fn state_ttl_extension_policy( self, ttl_extension_policy: TtlExtensionPolicy ) -> Self

Determine under what circumstances the TTL of your session state should be extended.

Defaults to `TtlExtensionPolicy::OnStateChanges` if left unspecified.

See `TtlExtensionPolicy` for more details.

## Trait Implementations§

source §

### impl Clone for BrowserSession

source §

#### fn clone(&self) -> BrowserSession

Returns a copy of the value. Read more
1.0.0 · source §

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

Performs copy-assignment from `source`. Read more
source §

### impl Debug for BrowserSession

source §

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

Formats the value using the given formatter. Read more
source §

### impl Default for BrowserSession

source §

#### fn default() -> Self

Returns the “default value” for a type. Read more
source §

### impl From<BrowserSession> for SessionLifecycle

source §

#### fn from(original: BrowserSession) -> SessionLifecycle

Converts to this type from the input type.

## Auto Trait Implementations§

§

### impl RefUnwindSafe for BrowserSession

§

### impl Send for BrowserSession

§

### impl Sync for BrowserSession

§

### impl Unpin for BrowserSession

§

### impl UnwindSafe for BrowserSession

## Blanket Implementations§

source §

### impl<T> Any for T
where T: 'static + ?Sized,

source §

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source §

### impl<T> Borrow<T> for T
where T: ?Sized,

source §

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source §

### impl<T> BorrowMut<T> for T
where T: ?Sized,

source §

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source §

### impl<T> From<T> for T

source §

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [`Span`], returning an `Instrumented` wrapper. Read more
§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
source §

### impl<T, U> Into<U> for T
where U: From<T>,

source §

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source §

### impl<T> Same for T

§

#### type Output = T

Should always be `Self`
source §

### impl<T> ToOwned for T
where T: Clone,

§

#### type Owned = T

The resulting type after obtaining ownership.
source §

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source §

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source §

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
source §

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source §

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source §

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

#### fn vzip(self) -> V

§

### impl<T> WithSubscriber for T

§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more