Skip to main content

RedisSessionStore

Struct RedisSessionStore 

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

Session store backed by a Redis server.

Sessions are stored as Redis strings keyed by rws:sess:{id} and given a Redis TTL via SET … EX. Expired sessions are removed automatically by Redis — no purge_expired sweep is needed.

Cloning is cheap — all clones share the same underlying TCP connection (one persistent connection per RedisSessionStore instance).

§Connection

Specify the server address as host:port (e.g. "127.0.0.1:6379"). Pass Some("password") for Redis servers that require AUTH. Use RedisSessionStore::from_env to read connection details from RWS_REDIS_HOST, RWS_REDIS_PORT, and RWS_REDIS_PASSWORD.

§Example

use rust_web_server::session::RedisSessionStore;

let store = RedisSessionStore::new("127.0.0.1:6379", None, 3600);

let mut sess = store.create().expect("create session");
sess.set("user_id", "42");
store.save(&sess).expect("save session");

let loaded = store.load(&sess.id).expect("load session").unwrap();
assert_eq!(Some("42"), loaded.get("user_id"));

Implementations§

Source§

impl RedisSessionStore

Source

pub fn new( addr: impl Into<String>, password: Option<String>, ttl_secs: u64, ) -> Self

Create a store that connects to addr (e.g. "127.0.0.1:6379"). password is passed to Redis AUTH if Some.

Source

pub fn from_env() -> Self

Build a store from environment variables:

  • RWS_REDIS_HOST (default 127.0.0.1)
  • RWS_REDIS_PORT (default 6379)
  • RWS_REDIS_PASSWORD (optional)
  • RWS_REDIS_TTL_SECS (default 3600)
Source

pub fn create(&self) -> Result<Session>

Create a new empty session and persist it to Redis.

Source

pub fn create_with_id(&self, id: String) -> Result<Session>

Create a new empty session with a caller-supplied ID and persist it.

Source

pub fn load(&self, id: &str) -> Result<Option<Session>>

Load a session by ID. Returns None if unknown or expired.

Source

pub fn save(&self, session: &Session) -> Result<()>

Persist a session’s data back to Redis, resetting the TTL.

Source

pub fn destroy(&self, id: &str) -> Result<()>

Delete a session immediately.

Source

pub fn purge_expired(&self)

No-op — Redis expiry removes sessions automatically.

Source

pub fn len(&self) -> Result<usize>

Total number of keys in the Redis database.

Uses DBSIZE, which counts all keys, not just session keys. Useful as a rough indicator; not exact for mixed-use Redis instances.

Source

pub fn is_empty(&self) -> Result<bool>

true if DBSIZE returns 0.

Trait Implementations§

Source§

impl Clone for RedisSessionStore

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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