Struct axum_session::Session

pub struct Session<T>where
    T: DatabasePool + Clone + Debug + Sync + Send + 'static,{
    pub(crate) store: SessionStore<T>,
    pub(crate) id: SessionID,
}

A Session Store.

Provides a Storage Handler to SessionStore and contains the SessionID(UUID) of the current session.

This is Auto generated by the Session Layer Upon Service Execution.

Fields

store: SessionStore<T>

The SessionStore that holds all the Sessions.

id: SessionID

The Sessions current ID for lookng up its store.

Implementations

impl<S> Session<S>where S: DatabasePool + Clone + Debug + Sync + Send + 'static,

pub(crate) async fn new( store: SessionStore<S>, value: Option<Uuid> ) -> (Self, bool)

pub(crate) async fn generate_uuid(store: &SessionStore<S>) -> SessionID

pub fn create_data(&self)

Sets the Session to create the SessionData based on the current Session ID. You can only use this if SessionMode::Manual is set or it will Panic. This will also set the store to true similair to session.set_store(true);

Examples

session.create_data();

pub fn data_exists(&self) -> bool

Checks if the SessionData was created or not.

Examples

if session.data_exists() {
    println!("data Exists");
}

pub fn renew(&self)

Sets the Session to renew its Session ID. This Deletes Session data from the database associated with the old UUID. This helps to enhance Security when logging into Secure area’s across a website. The current sessions data will be pushed to the database with the new UUID.

Examples

session.renew();

pub fn update(&self)

Sets the Session to force update the database. This will increase the Timer on the sessions store making the session live longer in the persistant database.

Examples

session.renew();

pub fn renew_key(&self)

Sets the Session to renew its Session Key ID and Encryption Key. This Deletes Session key data from the database associated with the old Key UUID. This helps to enhance Security when logging into Secure area’s across a website much further than renew() would. Will only work if SecurityMode::PerSession is Set. The new key data will be pushed to the database with the new key UUID.

It is recommended to use both renew() and renew_key together to better cycle the UUID’s.

Examples

session.renew_key();

pub fn destroy(&self)

Sets the Current Session to be Destroyed. This will Deleted the Session and Cookies upon Response Phase.

Examples

session.destroy();

pub fn set_longterm(&self, longterm: bool)

Sets the Current Session to a long term expiration. Useful for Remember Me setups. This will also update the database on Response Phase.

Examples

session.set_longterm(true);

pub fn set_store(&self, can_store: bool)

Allows the Current Session to store. This will also update the database on Response Phase.

This is only used when SessionMode is Manual or OptIn. This will allow the Session to be stored if true. This will delete and not allow a session to be stored if false.

Examples

session.set_store(true);

pub fn get<T: DeserializeOwned>(&self, key: &str) -> Option<T>

Gets data from the Session’s HashMap

Provides an Option that returns the requested data from the Sessions store. Returns None if Key does not exist or if serdes_json failed to deserialize.

Examples

let id = session.get("user-id").unwrap_or(0);

Used to get data stored within SessionDatas hashmap from a key value.

pub fn get_remove<T: DeserializeOwned>(&self, key: &str) -> Option<T>

Removes a Key from the Current Session’s HashMap returning it.

Provides an Option that returns the requested data from the Sessions store. Returns None if Key does not exist or if serdes_json failed to deserialize.

Examples

let id = session.get_remove("user-id").unwrap_or(0);

Used to get data stored within SessionDatas hashmap from a key value.

pub fn set(&self, key: &str, value: impl Serialize)

Sets data to the Current Session’s HashMap. This will also update the database on Response Phase.

Examples

session.set("user-id", 1);

pub fn remove(&self, key: &str)

Removes a Key from the Current Session’s HashMap. Does not process the String into a Type, Just removes it. This will also update the database on Response Phase.

Examples

let _ = session.remove("user-id");

pub fn clear(&self)

Clears all data from the Current Session’s HashMap instantly. This will also update the database on Response Phase.

Examples

session.clear();

pub async fn count(&self) -> i64

Returns a i64 count of how many Sessions exist.

If the Session is persistant it will return all sessions within the database. If the Session is not persistant it will return a count within SessionStore.

Examples

let count = session.count().await;

pub fn get_session_id(&self) -> SessionID

Returns the SessionID for this Session.

The SessionID contains the Uuid generated at the beginning of this Session.

Examples

let session_id = session.get_session_id();

pub fn get_store(&self) -> &SessionStore<S>

Returns the store for this Session.

The store contains everything that all sessions need.

Examples

let store = session.get_store();

pub fn get_mut_store(&mut self) -> &mut SessionStore<S>

Returns a mutable store for this Session.

The store contains everything that all sessions need.

Examples

let store = session.get_store_mut();

pub(crate) fn remove_request(&self)

Removes a Request from the request counter used to deturmine if parallel requests exist. prevents data deletion until requests == 0.

Examples

session.remove_request();

pub(crate) fn set_request(&self)

Removes a Request from the request counter used to deturmine if parallel requests exist. prevents data deletion until requests == 0.

Examples

session.set_request();

pub(crate) fn is_parallel(&self) -> bool

checks if a session has more than one request.

Examples

session.is_parallel();

pub fn verify(&self) -> Result<(), SessionError>

checks if a session exists and if it is outdated.

Examples

session.verify();

pub fn update_database_expires(&self) -> Result<(), SessionError>

Updates the sessions stored database expire time. Use this before forcing a update to the database store. will update the database expires based on if the session is longterm then configs max_lifespan. if not then configs lifespan.

THIS WILL NOT UPDATE THE DATABASE SIDE.

Examples

session.update_database_expires();

pub fn update_memory_expires(&self) -> Result<(), SessionError>

Updates the Sessions In memory auto remove timer. Will prevent it from being removed for the configs set memory_lifespan.

Examples

session.update_memory_expires();

pub async fn force_database_update(&self) -> Result<(), SessionError>

forces a update to the databases stored data for the session. Make sure to update the databases expire time before running this or the data could be unloaded by a request checking for outdated sessions.

Examples

session.force_database_update().await;

pub fn memory_remove_session(&self) -> Result<(), SessionError>

Removes the session from the memory store if it is not parallel. If it is parallel then each parallel session will need to call this once. when all parallel sessions are dead this gets unloaded.

THIS DOES NOT CLEAR THE KEY STORE.

Examples

session.memory_remove_session();

pub async fn database_remove_session(&self) -> Result<(), SessionError>

Removes the session from the Database store.

THIS DOES NOT REMOVE THE KEY STORE.

Examples

session.database_remove_session().await;

Trait Implementations

impl<T> Clone for Session<T>where T: DatabasePool + Clone + Debug + Sync + Send + 'static + Clone,

fn clone(&self) -> Session<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Session<T>where T: DatabasePool + Clone + Debug + Sync + Send + 'static + Debug,

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

Formats the value using the given formatter.

impl<T> From<Session<T>> for ReadOnlySession<T>where T: DatabasePool + Clone + Debug + Sync + Send + 'static,

fn from(session: Session<T>) -> Self

Converts to this type from the input type.

impl<T, S> FromRequestParts<S> for Session<T>where T: DatabasePool + Clone + Debug + Sync + Send + 'static, S: Send + Sync,

Adds FromRequestParts for Session

Returns the Session from Axums request extensions state.

type Rejection = (StatusCode, &'static str)

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

fn from_request_parts<'life0, 'life1, 'async_trait>( parts: &'life0 mut Parts, _state: &'life1 S ) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Perform the extraction.