Struct axum_session::ReadOnlySession

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

Fields

store: SessionStore<T>

id: SessionID

Implementations

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

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 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;

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for ReadOnlySession<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 ReadOnlySession<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.