ExpiringMemoryStore

Struct ExpiringMemoryStore 

Source
pub struct ExpiringMemoryStore { /* private fields */ }
Expand description

Why? The tower_session MemoryStore by default does not delete entries in time. Which may cause memory leak over long run. Java’s auto session management has no memory leak issue. Rust Axum should not have that issue, too!

The ExpiringMemoryStore automatically deletes object that is expired The data is stored internally as Arc<RwLock<HashMap<Id, Record>> The expiry is tracked by the ascending VecDequeue using creation time

Upon create, a background tokio thread is immediately started to delete expired session automatically every 5 seconds. Upon dropping the ExpiringMemoryStore, the background tokio thread is automatically cancelled. #Example

use axum::routing::get;
use axum::Router;
use std::net::SocketAddr;
use tower_sessions::{cookie::time::{self, Duration, OffsetDateTime}, Expiry, Session, SessionManagerLayer};
 
#[tokio::main]
async fn main() {
  let session_store = tower_sessions_auto_memory_store::ExpiringMemoryStore::new();
  let session_layer = SessionManagerLayer::new(session_store)
     .with_secure(false)
     .with_expiry(Expiry::OnInactivity(Duration::seconds(1800)));
  let app = Router::new()
     .route("/debug/test", get(root))
     .layer(session_layer);
   let addr = SocketAddr::from(([0, 0, 0, 0], 3000));
   println!("listening on {}", addr);
   axum_server::bind(addr)
     .serve(app.into_make_service())
     .await
     .unwrap();
}
 
async fn root() -> &'static str {
  "Hello, World!"
}

Implementations§

Source§

impl ExpiringMemoryStore

Source

pub fn new() -> Self

Create a new ExpiringMemoryStore

Trait Implementations§

Source§

impl Clone for ExpiringMemoryStore

Source§

fn clone(&self) -> ExpiringMemoryStore

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ExpiringMemoryStore

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for ExpiringMemoryStore

Upon dropping, the background thread will be killed.

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl SessionStore for ExpiringMemoryStore

Source§

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

Saves the provided session record to the store. Read more
Source§

fn create<'life0, 'life1, 'async_trait>( &'life0 self, record: &'life1 mut Record, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Creates a new session in the store with the provided session record. Read more
Source§

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

Loads an existing session record from the store using the provided ID. Read more
Source§

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

Deletes a session record from the store using the provided ID. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more