Struct async_mongodb_session::MongodbSessionStore

pub struct MongodbSessionStore { /* fields omitted */ }

A MongoDB session store.

Implementations

impl MongodbSessionStore

pub async fn new<'_, '_, '_>(
    uri: &'_ str,
    db: &'_ str,
    coll_name: &'_ str
) -> Result<Self>

Create a new instance of MongodbSessionStore after stablish the connection to monngodb.

let store =
MongodbSessionStore::new("mongodb://127.0.0.1:27017", "db_name", "collection")
.await?;

pub fn from_client(client: Client, db: &str, coll_name: &str) -> Self

Create a new instance of MongodbSessionStore from an open client.

use mongodb::{options::ClientOptions, Client};

            let client_options = match ClientOptions::parse("mongodb://127.0.0.1:27017").await {
    Ok(c) => c,
    Err(e) => panic!("Client Options Failed: {}", e),
};
let client = match Client::with_options(client_options) {
    Ok(c) => c,
    Err(e) => panic!("Client Creation Failed: {}", e),
};
let store = MongodbSessionStore::from_client(client, "db_name", "collection");

pub async fn initialize<'_>(&'_ self) -> Result

Initialize the default expiration mechanism, based on the document expiration that mongodb provides https://docs.mongodb.com/manual/tutorial/expire-data/#expire-documents-at-a-specific-clock-time. The default ttl applyed to sessions without expiry is 20 minutes. If the expireAt date field contains a date in the past, mongodb considers the document expired and will be deleted. Note: mongodb runs the expiration logic every 60 seconds.

let store =
MongodbSessionStore::new("mongodb://127.0.0.1:27017", "db_name", "collection")
.await?;
store.initialize().await?;

pub async fn index_on_expiry_at<'_>(&'_ self) -> Result

Create a new index for the expireAt property, allowing to expire sessions at a specific clock time. If the expireAt date field contains a date in the past, mongodb considers the document expired and will be deleted. https://docs.mongodb.com/manual/tutorial/expire-data/#expire-documents-at-a-specific-clock-time

let store =
MongodbSessionStore::new("mongodb://127.0.0.1:27017", "db_name", "collection")
.await?;
store.index_on_expiry_at().await?;

Trait Implementations

impl Clone for MongodbSessionStore

pub fn clone(&self) -> MongodbSessionStore

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MongodbSessionStore

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

Formats the value using the given formatter.

impl SessionStore for MongodbSessionStore

pub fn store_session<'life0, 'async_trait>(
    &'life0 self,
    session: Session
) -> Pin<Box<dyn Future<Output = Result<Option<String>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Store a session on the storage backend.

pub fn load_session<'life0, 'async_trait>(
    &'life0 self,
    cookie_value: String
) -> Pin<Box<dyn Future<Output = Result<Option<Session>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Get a session from the storage backend.

pub fn destroy_session<'life0, 'async_trait>(
    &'life0 self,
    session: Session
) -> Pin<Box<dyn Future<Output = Result> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Remove a session from the session store

pub fn clear_store<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Empties the entire store, destroying all sessions