# Struct actix_session::config::PersistentSession

source ·

    pub struct PersistentSession { /* private fields */ }

Expand description

A session lifecycle strategy where the session cookie will be persistent.

Persistent cookies have a pre-determined expiration, specified via the `Max-Age` or `Expires` attribute. They do not disappear when the current browser session ends.

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

## Examples

    use actix_web::cookie::time::Duration;
    use actix_session::SessionMiddleware;
    use actix_session::config::{PersistentSession, TtlExtensionPolicy};

    const SECS_IN_WEEK: i64 = 60 * 60 * 24 * 7;

    // a session lifecycle with a time-to-live (expiry) of 1 week and default extension policy
    PersistentSession::default().session_ttl(Duration::seconds(SECS_IN_WEEK));

    // a session lifecycle with the default time-to-live (expiry) and a custom extension policy
    PersistentSession::default()
        // this policy causes the session state's TTL to be refreshed on every request
        .session_ttl_extension_policy(TtlExtensionPolicy::OnEveryRequest);

## Implementations§

source§

### impl PersistentSession

source

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

Specifies how long the session cookie should live.

The session TTL is also used as the TTL for the session state in the storage backend.

Defaults to 1 day.

A persistent session can live more than the specified TTL if the TTL is extended. See `session_ttl_extension_policy` for more details.

source

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

Determines under what circumstances the TTL of your session should be extended. See `TtlExtensionPolicy` for more details.

Defaults to `TtlExtensionPolicy::OnStateChanges`.

## Trait Implementations§

source§

### impl Clone for PersistentSession

source§

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

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 PersistentSession

source§

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

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

### impl Default for PersistentSession

source§

#### fn default() -> Self

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

### impl From<PersistentSession> for SessionLifecycle

source§

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

Converts to this type from the input type.

## Auto Trait Implementations§

§

### impl RefUnwindSafe for PersistentSession

§

### impl Send for PersistentSession

§

### impl Sync for PersistentSession

§

### impl Unpin for PersistentSession

§

### impl UnwindSafe for PersistentSession

## Blanket Implementations§

source§

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

source§

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

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

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

source§

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

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere 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 Twhere 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 Twhere 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 Twhere 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 Twhere 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 Twhere 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