Struct tower_sessions::SessionManagerLayer

pub struct SessionManagerLayer<Store: SessionStore> { /* private fields */ }

A layer for providing Session as a request extension.

Implementations

impl<Store: SessionStore> SessionManagerLayer<Store>

pub fn with_name(self, name: &str) -> Self

Configures the name of the cookie used for the session.

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_same_site(self, same_site: SameSite) -> Self

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

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_max_age(self, max_age: Duration) -> Self

Configures the "Max-Age" attribute of the cookie used for the session.

Examples

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

let session_store = MemoryStore::default();
let session_service = SessionManagerLayer::new(session_store).with_max_age(Duration::hours(1));

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

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

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(self, path: String) -> Self

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

Examples

use tower_sessions::{MemoryStore, SessionManagerLayer};

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

pub fn with_domain(self, domain: String) -> Self

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

Examples

use tower_sessions::{MemoryStore, SessionManagerLayer};

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

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> Clone for SessionManagerLayer<Store>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Store: Debug + SessionStore> Debug for SessionManagerLayer<Store>

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

Formats the value using the given formatter.

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

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

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.