MemoryStore

Struct MemoryStore 

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

§in-memory session store

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

§DO NOT USE THIS IN A PRODUCTION DEPLOYMENT.

Implementations§

Source§

impl MemoryStore

Source

pub fn new() -> MemoryStore

Create a new instance of MemoryStore

Examples found in repository?
examples/simple.rs (line 6)
5async fn main() {
6    let session_store = MemoryStore::new();
7
8    let route = warp::get()
9        .and(warp::path!("test"))
10        .and(warp_sessions::request::with_session(session_store, None))
11        .and_then(
12            move |session_with_store: SessionWithStore<MemoryStore>| async move {
13                Ok::<_, Rejection>((
14                    warp::reply::html("<html></html>".to_string()),
15                    session_with_store,
16                ))
17            },
18        )
19        .untuple_one()
20        .and_then(warp_sessions::reply::with_session);
21
22    // Start the server
23    let port = 8080;
24    println!("starting server listening on ::{}", port);
25    warp::serve(route).run(([0, 0, 0, 0], port)).await;
26}
More examples
Hide additional examples
examples/cookie_options.rs (line 6)
5async fn main() {
6    let session_store = MemoryStore::new();
7
8    let route = warp::get()
9        .and(warp::path!("test"))
10        .and(warp_sessions::request::with_session(
11            session_store,
12            Some(CookieOptions {
13                cookie_name: "sid",
14                cookie_value: None,
15                max_age: Some(600),
16                domain: Some("domain.com".to_string()),
17                path: Some("/test".to_string()),
18                secure: true,
19                http_only: true,
20                same_site: Some(SameSiteCookieOption::Strict),
21            }),
22        ))
23        .and_then(
24            move |session_with_store: SessionWithStore<MemoryStore>| async move {
25                Ok::<_, Rejection>((
26                    warp::reply::html("<html></html>".to_string()),
27                    session_with_store,
28                ))
29            },
30        )
31        .untuple_one()
32        .and_then(warp_sessions::reply::with_session);
33
34    // Start the server
35    let port = 8080;
36    println!("starting server listening on ::{}", port);
37    warp::serve(route).run(([0, 0, 0, 0], port)).await;
38}
examples/shared_mutable_session.rs (line 12)
11async fn main() {
12    let session_store = MemoryStore::new();
13
14    let route = warp::get()
15        .and(warp::path!("test"))
16        .and(warp_sessions::request::with_session(session_store, None))
17        .and_then(
18            move |mut session_with_store: SessionWithStore<MemoryStore>| async move {
19                let shared_session = Arc::new(RwLock::new(session_with_store.session));
20                shared_session
21                    .write()
22                    .unwrap()
23                    .insert("key", "value")
24                    .unwrap();
25                session_with_store.session = Arc::try_unwrap(shared_session)
26                    .unwrap()
27                    .into_inner()
28                    .unwrap();
29
30                Ok::<_, Rejection>((
31                    warp::reply::html("<html></html>".to_string()),
32                    session_with_store,
33                ))
34            },
35        )
36        .untuple_one()
37        .and_then(warp_sessions::reply::with_session);
38
39    // Start the server
40    let port = 8080;
41    println!("starting server listening on ::{}", port);
42    warp::serve(route).run(([0, 0, 0, 0], port)).await;
43}
examples/multiple_routes.rs (line 6)
5async fn main() {
6    let session_store = MemoryStore::new();
7
8    let route_get = warp::get()
9        .and(warp::path!("test"))
10        .and(warp_sessions::request::with_session(
11            session_store.clone(),
12            None,
13        ))
14        .and_then(
15            move |session_with_store: SessionWithStore<MemoryStore>| async move {
16                Ok::<_, Rejection>((
17                    warp::reply::html("<html></html>".to_string()),
18                    session_with_store,
19                ))
20            },
21        )
22        .untuple_one()
23        .and_then(warp_sessions::reply::with_session);
24
25    let route_post = warp::post()
26        .and(warp::path!("test"))
27        .and(warp_sessions::request::with_session(
28            session_store.clone(),
29            None,
30        ))
31        .and_then(
32            move |session_with_store: SessionWithStore<MemoryStore>| async move {
33                Ok::<_, Rejection>((
34                    warp::reply::html("<html></html>".to_string()),
35                    session_with_store,
36                ))
37            },
38        )
39        .untuple_one()
40        .and_then(warp_sessions::reply::with_session);
41
42    // Start the server
43    let port = 8080;
44    println!("starting server listening on ::{}", port);
45    warp::serve(route_get.or(route_post))
46        .run(([0, 0, 0, 0], port))
47        .await;
48}
Source

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

Source

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§

Source§

impl Clone for MemoryStore

Source§

fn clone(&self) -> MemoryStore

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 MemoryStore

Source§

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

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

impl SessionStore for MemoryStore

Source§

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. Read more
Source§

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. Read more
Source§

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
Source§

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

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> 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> Same for T

Source§

type Output = T

Should always be Self
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
Source§

impl<T> ErasedDestructor for T
where T: 'static,