Struct MemoryStore 

pub struct MemoryStore { /* private fields */ }

in-memory session store

Because there is no external persistance, this session store is ephemeral and will be cleared on server restart.

READ THIS BEFORE USING IN A PRODUCTION DEPLOYMENT

Storing sessions only in memory brings the following problems:

1. All sessions must fit in available memory (important for high load services)
2. Sessions stored in memory are cleared only if a client calls MemoryStore::destroy_session or MemoryStore::clear_store. If sessions are not cleaned up properly it might result in OOM
3. All sessions will be lost on shutdown
4. If the service is clustered particular session will be stored only on a single instance. This might be solved by using load balancers with sticky sessions. Unfortunately, this solution brings additional complexity especially if the connection is using secure transport since the load balancer has to perform SSL termination to understand where should it forward packets to

Example crates providing alternative implementations:

• async-sqlx-session postgres & sqlite
• async-redis-session
• async-mongodb-session

Implementations

impl MemoryStore

pub fn new() -> MemoryStore

Create a new instance of MemoryStore

pub async fn cleanup(&self) -> Result<(), Error>

Performs session cleanup. This should be run on an intermittent basis if this store is run for long enough that memory accumulation is a concern

pub async fn count(&self) -> usize

returns the number of elements in the memory store

Example

let mut store = MemoryStore::new();
assert_eq!(store.count().await, 0);
store.store_session(Session::new()).await?;
assert_eq!(store.count().await, 1);

Trait Implementations

impl Clone for MemoryStore

fn clone(&self) -> MemoryStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryStore

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

Formats the value using the given formatter.

impl Default for MemoryStore

fn default() -> MemoryStore

Returns the “default value” for a type.

impl SessionStore for MemoryStore

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

where 'life0: 'async_trait, MemoryStore: 'async_trait,

Get a session from the storage backend.

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

where 'life0: 'async_trait, MemoryStore: 'async_trait,

Store a session on the storage backend.

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

where 'life0: 'async_trait, MemoryStore: 'async_trait,

Remove a session from the session store

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

where 'life0: 'async_trait, MemoryStore: 'async_trait,

Empties the entire store, destroying all sessions