Struct tower_sessions::service::SessionManagerLayer

pub struct SessionManagerLayer<Store: SessionStore, C: CookieController = PlaintextCookie> { /* private fields */ }

A layer for providing Session as a request extension.

Implementations

impl<Store: SessionStore, C: CookieController> SessionManagerLayer<Store, C>

pub fn with_name<N: Into<Cow<'static, str>>>(self, name: N) -> Self

Configures the name of the cookie used for the session. The default value is "id".

Examples

use tower_sessions::{MemoryStore, SessionManagerLayer};

let session_store = MemoryStore::default();
let session_service = SessionManagerLayer::new(session_store).with_name("my.sid");

pub fn with_http_only(self, http_only: bool) -> Self

Configures the "HttpOnly" attribute of the cookie used for the session.

⚠️ Warning: Cross-site scripting risk

Applications should generally not override the default value of true. If you do, you are exposing your application to increased risk of cookie theft via techniques like cross-site scripting.

Examples

use tower_sessions::{MemoryStore, SessionManagerLayer};

let session_store = MemoryStore::default();
let session_service = SessionManagerLayer::new(session_store).with_http_only(true);

pub fn with_same_site(self, same_site: SameSite) -> Self

Configures the "SameSite" attribute of the cookie used for the session. The default value is SameSite::Strict.

Examples

use tower_sessions::{cookie::SameSite, MemoryStore, SessionManagerLayer};

let session_store = MemoryStore::default();
let session_service = SessionManagerLayer::new(session_store).with_same_site(SameSite::Lax);

pub fn with_expiry(self, expiry: Expiry) -> Self

Configures the "Max-Age" attribute of the cookie used for the session. The default value is None.

Examples

use time::Duration;
use tower_sessions::{Expiry, MemoryStore, SessionManagerLayer};

let session_store = MemoryStore::default();
let session_expiry = Expiry::OnInactivity(Duration::hours(1));
let session_service = SessionManagerLayer::new(session_store).with_expiry(session_expiry);

pub fn with_secure(self, secure: bool) -> Self

Configures the "Secure" attribute of the cookie used for the session. The default value is true.

Examples

use tower_sessions::{MemoryStore, SessionManagerLayer};

let session_store = MemoryStore::default();
let session_service = SessionManagerLayer::new(session_store).with_secure(true);

pub fn with_path<P: Into<Cow<'static, str>>>(self, path: P) -> Self

Configures the "Path" attribute of the cookie used for the session. The default value is "/".

Examples

use tower_sessions::{MemoryStore, SessionManagerLayer};

let session_store = MemoryStore::default();
let session_service = SessionManagerLayer::new(session_store).with_path("/some/path");

pub fn with_domain<D: Into<Cow<'static, str>>>(self, domain: D) -> Self

Configures the "Domain" attribute of the cookie used for the session. The default value is None.

Examples

use tower_sessions::{MemoryStore, SessionManagerLayer};

let session_store = MemoryStore::default();
let session_service = SessionManagerLayer::new(session_store).with_domain("localhost");

pub fn with_signed(self, key: Key) -> SessionManagerLayer<Store, SignedCookie>

Manages the session cookie via a signed interface.

See SignedCookies.

use tower_sessions::{cookie::Key, MemoryStore, SessionManagerLayer};

let key = { /* a cryptographically random key >= 64 bytes */ };

let session_store = MemoryStore::default();
let session_service = SessionManagerLayer::new(session_store).with_signed(key);

pub fn with_private(self, key: Key) -> SessionManagerLayer<Store, PrivateCookie>

Manages the session cookie via an encrypted interface.

See PrivateCookies.

use tower_sessions::{cookie::Key, MemoryStore, SessionManagerLayer};

let key = { /* a cryptographically random key >= 64 bytes */ };

let session_store = MemoryStore::default();
let session_service = SessionManagerLayer::new(session_store).with_private(key);

impl<Store: SessionStore> SessionManagerLayer<Store>

pub fn new(session_store: Store) -> Self

Create a new SessionManagerLayer with the provided session store and default cookie configuration.

Examples

use tower_sessions::{MemoryStore, SessionManagerLayer};

let session_store = MemoryStore::default();
let session_service = SessionManagerLayer::new(session_store);

Trait Implementations

impl<Store: Clone + SessionStore, C: Clone + CookieController> Clone for SessionManagerLayer<Store, C>

fn clone(&self) -> SessionManagerLayer<Store, C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Store: Debug + SessionStore, C: Debug + CookieController> Debug for SessionManagerLayer<Store, C>

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

Formats the value using the given formatter.

impl<S, Store: SessionStore, C: CookieController> Layer<S> for SessionManagerLayer<Store, C>

type Service = CookieManager<SessionManager<S, Store, C>>

The wrapped service

fn layer(&self, inner: S) -> Self::Service

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.