Struct tower_sessions::SqliteStore

pub struct SqliteStore { /* private fields */ }

Available on crate features sqlite-store and sqlx-store only.

A SQLite session store.

Implementations

impl SqliteStore

pub fn new(pool: SqlitePool) -> Self

Create a new SQLite store with the provided connection pool.

Examples

use tower_sessions::{sqlx::SqlitePool, SqliteStore};

let pool = SqlitePool::connect("sqlite::memory:").await.unwrap();
let session_store = SqliteStore::new(pool);

pub fn with_table_name( self, table_name: impl AsRef<str> ) -> Result<Self, String>

Set the session table name with the provided name.

pub async fn migrate(&self) -> Result<()>

Migrate the session schema.

pub async fn continuously_delete_expired( self, period: Duration ) -> Result<(), Error>

This function will keep running indefinitely, deleting expired rows and then waiting for the specified period before deleting again.

Generally this will be used as a task, for example via tokio::task::spawn.

Arguments

• period - The interval at which expired rows should be deleted.

Errors

This function returns a Result that contains an error of type sqlx::Error if the deletion operation fails.

Examples

use tower_sessions::{sqlx::SqlitePool, SqliteStore};

let pool = SqlitePool::connect("sqlite::memory:").await.unwrap();
let session_store = SqliteStore::new(pool);

tokio::task::spawn(
    session_store
        .clone()
        .continuously_delete_expired(tokio::time::Duration::from_secs(60)),
);

Trait Implementations

impl Clone for SqliteStore

fn clone(&self) -> SqliteStore

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SqliteStore

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

Formats the value using the given formatter.

impl SessionStore for SqliteStore

type Error = SqlxStoreError

An error that occurs when interacting with the store.

fn save<'life0, 'life1, 'async_trait>( &'life0 self, session_record: &'life1 SessionRecord ) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

A method for saving a session in a store.

fn load<'life0, 'life1, 'async_trait>( &'life0 self, session_id: &'life1 SessionId ) -> Pin<Box<dyn Future<Output = Result<Option<Session>, Self::Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

A method for loading a session from a store.

fn delete<'life0, 'life1, 'async_trait>( &'life0 self, session_id: &'life1 SessionId ) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

A method for deleting a session from a store.