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: &mut SessionStore<S>, cookies: &CookieJar, session_key: &SessionKey ) -> (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 key. This helps to enhance Security when logging into Secure area’s across a website.

Examples

session.renew();

pub fn renew_key(&self)

Sets the Session to renew its Session’s Encryption Key. This renews the Session’s Encryption Key in the database. Also it Generates a new Uuid for the Session’s Key. This helps to enhance Security when logging into Secure area’s across a website.

Examples

session.renew_key();

pub fn destroy(&self)

Sets the Current Session to be Destroyed on the next run.

Examples

session.destroy();

pub fn set_longterm(&self, longterm: bool)

Sets the Current Session to a long term expiration. Useful for Remember Me setups.

Examples

session.set_longterm(true);

pub fn set_store(&self, storable: bool)

Sets the Current Session to be storable.

This will allow the Session to save its data for the lifetime if set to true. If this is set to false it will unload the stored session.

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.

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.

Examples

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

pub fn clear(&self)

Clears all data from the Current Session’s HashMap.

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 async 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().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.