Struct Session

Source

pub struct Session<B>where
    B: SessionBackend,
{ /* private fields */ }

Available on native and crate feature sessions only.

Expand description

Django-style session object with dictionary-like interface

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

// Set session data
session.set("user_id", 42)?;
session.set("username", "alice")?;

// Get session data
let user_id: i32 = session.get("user_id")?.unwrap();
assert_eq!(user_id, 42);

// Check if key exists
assert!(session.contains_key("username"));

// Delete a key
session.delete("username");

// Save session
session.save().await?;

Implementations§

Source §

impl Session
where B: SessionBackend,

Source

pub fn new(backend: B) -> Session

Available on crate feature auth only.

Create a new session with the given backend

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let session = Session::new(backend);

Source

pub async fn from_key( backend: B, session_key: String, ) -> Result<Session, SessionError>

Available on crate feature auth only.

Create a session from an existing session key

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let session = Session::from_key(backend, "session_key_123".to_string()).await?;

Source

pub fn get<T>(&mut self, key: &str) -> Result<Option<T>, Error>
where T: for<'de> Deserialize<'de>,

Available on crate feature auth only.

Get a value from the session

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

session.set("count", 42)?;
let count: i32 = session.get("count")?.unwrap();
assert_eq!(count, 42);

Source

pub fn set<T>(&mut self, key: &str, value: T) -> Result<(), Error>
where T: Serialize,

Available on crate feature auth only.

Set a value in the session

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

session.set("user_id", 123)?;
session.set("username", "alice")?;

Source

pub fn delete(&mut self, key: &str) -> Option<Value>

Available on crate feature auth only.

Delete a key from the session

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

session.set("temp", "value")?;
assert!(session.contains_key("temp"));

session.delete("temp");
assert!(!session.contains_key("temp"));

Source

pub fn contains_key(&self, key: &str) -> bool

Available on crate feature auth only.

Check if a key exists in the session

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

session.set("key", "value")?;
assert!(session.contains_key("key"));
assert!(!session.contains_key("nonexistent"));

Source

pub fn get_or_create_key(&mut self) -> &str

Available on crate feature auth only.

Get the session key (creates one if it doesn’t exist)

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

let key = session.get_or_create_key();
assert!(!key.is_empty());

Source

pub fn generate_key() -> String

Available on crate feature auth only.

Generate a new random session key

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let key = Session::<InMemorySessionBackend>::generate_key();
assert!(!key.is_empty());
assert!(key.len() > 20);

Source

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

Available on crate feature auth only.

Flush the session (delete all data and create new key)

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

session.set("key", "value")?;
let old_key = session.get_or_create_key().to_string();

session.flush().await?;

// Data is cleared
assert!(!session.contains_key("key"));
// New session key is generated
assert_ne!(session.get_or_create_key(), old_key);

Source

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

Available on crate feature auth only.

Cycle the session key (keep data but change key)

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

session.set("user_id", 123)?;
let old_key = session.get_or_create_key().to_string();

session.cycle_key().await?;

// Data is preserved
let user_id: i32 = session.get("user_id")?.unwrap();
assert_eq!(user_id, 123);

// Session key has changed
assert_ne!(session.get_or_create_key(), old_key);

Source

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

Available on crate feature auth only.

Regenerate session ID to prevent session fixation attacks

This method creates a new session ID while preserving all session data. It should be called after authentication (login) to prevent session fixation attacks.

§Security

Session fixation is an attack where an attacker sets a victim’s session ID to a known value. By regenerating the session ID after login, we ensure that even if an attacker knew the pre-authentication session ID, it becomes invalid after the user logs in.

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

// User logs in
session.set("user_id", 123)?;

// Regenerate session ID to prevent session fixation
session.regenerate_id().await?;

// Session data is preserved
let user_id: i32 = session.get("user_id")?.unwrap();
assert_eq!(user_id, 123);

Source

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

Available on crate feature auth only.

Save the session to the backend

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

session.set("data", "value")?;
session.save().await?;

Source

pub fn is_modified(&self) -> bool

Available on crate feature auth only.

Check if the session has been modified

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

assert!(!session.is_modified());

session.set("key", "value")?;
assert!(session.is_modified());

Source

pub fn is_accessed(&self) -> bool

Available on crate feature auth only.

Check if the session has been accessed

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

assert!(!session.is_accessed());

session.get::<String>("key")?;
assert!(session.is_accessed());

Source

pub fn session_key(&self) -> Option<&str>

Available on crate feature auth only.

Get the current session key (if any)

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let session = Session::new(backend);

assert!(session.session_key().is_none());

Source

pub fn keys(&mut self) -> Vec<String>

Available on crate feature auth only.

Get all session keys

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

session.set("user_id", 123)?;
session.set("username", "alice")?;

let keys = session.keys();
assert_eq!(keys.len(), 2);
assert!(keys.contains(&"user_id".to_string()));
assert!(keys.contains(&"username".to_string()));

Source

pub fn values(&mut self) -> Vec<&Value>

Available on crate feature auth only.

Get all session values

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

session.set("count", 42)?;
session.set("name", "test")?;

let values = session.values();
assert_eq!(values.len(), 2);

Source

pub fn items(&mut self) -> Vec<(&String, &Value)>

Available on crate feature auth only.

Get all session key-value pairs

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

session.set("user_id", 123)?;
session.set("role", "admin")?;

let items = session.items();
assert_eq!(items.len(), 2);

// Find specific item
let user_id_item = items.iter()
    .find(|(k, _)| k.as_str() == "user_id")
    .unwrap();
assert_eq!(user_id_item.1.as_i64().unwrap(), 123);

Source

pub fn clear(&mut self)

Available on crate feature auth only.

Clear all session data

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

session.set("user_id", 123)?;
session.set("username", "alice")?;

assert_eq!(session.keys().len(), 2);

session.clear();

assert_eq!(session.keys().len(), 0);
assert!(session.is_modified());

Source

pub fn mark_modified(&mut self)

Available on crate feature auth only.

Manually mark the session as modified

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

assert!(!session.is_modified());

session.mark_modified();
assert!(session.is_modified());

Source

pub fn mark_unmodified(&mut self)

Available on crate feature auth only.

Manually mark the session as unmodified

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

session.set("key", "value")?;
assert!(session.is_modified());

session.mark_unmodified();
assert!(!session.is_modified());

Source

pub fn set_timeout(&mut self, timeout: u64)

Available on crate feature auth only.

Set session timeout in seconds

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

// Set timeout to 1 hour (3600 seconds)
session.set_timeout(3600);

Source

pub fn get_timeout(&self) -> u64

Available on crate feature auth only.

Get session timeout in seconds

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let session = Session::new(backend);

// Default timeout is 1800 seconds (30 minutes)
assert_eq!(session.get_timeout(), 1800);

Source

pub fn update_activity(&mut self)

Available on crate feature auth only.

Update last activity timestamp

This should be called on each request to update the session’s last activity time.

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

// Update activity timestamp
session.update_activity();

Source

pub fn get_last_activity(&self) -> Option<DateTime<Utc>>

Available on crate feature auth only.

Get last activity timestamp

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let session = Session::new(backend);

// Last activity is set on creation
assert!(session.get_last_activity().is_some());

Source

pub fn is_timed_out(&self) -> bool

Available on crate feature auth only.

Check if session has timed out

Returns true if the session has exceeded its timeout period based on last activity.

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

// New session should not be timed out
assert!(!session.is_timed_out());

// Set very short timeout
session.set_timeout(0);
// Still not timed out immediately (last_activity is now)
assert!(!session.is_timed_out());

Source

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

Available on crate feature auth only.

Validate session timeout

Returns an error if the session has timed out.

§Example

use reinhardt_auth::sessions::Session;
use reinhardt_auth::sessions::backends::InMemorySessionBackend;

let backend = InMemorySessionBackend::new();
let mut session = Session::new(backend);

// Validate timeout (should succeed for new session)
session.validate_timeout()?;

Trait Implementations§

Source §

impl Clone for Session
where B: Clone + SessionBackend,

Source §

fn clone(&self) -> Session

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§

§

impl UnwindSafe for Session
where B: UnwindSafe,

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> Any for T
where T: Any,

Source §

fn into_any(self: Box<T>) -> Box<dyn Any>

Source §

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Source §

fn type_name(&self) -> &'static str

Source §

impl<T> AnySync for T
where T: Any + Send + Sync,

Source §

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Source §

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source §

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source §

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source §

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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

Source §

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

Source §

impl<T> FmtForward for T

Source §

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

Source §

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

Source §

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

Source §

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

Source §

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

Source §

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

Source §

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

Source §

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

Source §

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> FromRef<T> for T
where T: Clone,

Source §

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

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

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

impl<T> IntoRequest<T> for T

Source §

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

Source §

impl<T> IntoResult<T> for T

Source §

type Err = !

Source §

fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>

Source §

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source §

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.

Source §

impl<L> LayerExt<L> for L

Source §

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.

Source §

impl<T> Pipe for T
where T: ?Sized,

Source §

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

Source §

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

Source §

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

Source §

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

Source §

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

Source §

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

Source §

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

Source §

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

Source §

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

Source §

impl<T> Pointable for T

Source §

const ALIGN: usize

The alignment of pointer.

Source §

type Init = T

The type for initializers.

Source §

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

Source §

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

Source §

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

Source §

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

Source §

impl<T> PolicyExt for T
where T: ?Sized,

Source §

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

Source §

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

Source §

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source §

impl<T> Same for T

Source §

type Output = T

Should always be Self

Source §

impl<T> Tap for T

Source §

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

Source §

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

Source §

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

Source §

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

Source §

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

Source §

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

Source §

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

Source §

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

Source §

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

Source §

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

Source §

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

Source §

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

Source §

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

Source §

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

Source §

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

Source §

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

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

Source §

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

Source §

impl<T, U> TryFrom for T
where U: Into<T>,

Source §

type Error = !

The type returned in the event of a conversion error.

Source §

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Source §

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source §

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more

Source §

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more

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

Struct Session Copy item path

§Example

Implementations§

impl<B> Session<B>where B: SessionBackend,

pub fn new(backend: B) -> Session<B>

§Example

pub async fn from_key( backend: B, session_key: String, ) -> Result<Session<B>, SessionError>

§Example

pub fn get<T>(&mut self, key: &str) -> Result<Option<T>, Error>where T: for<'de> Deserialize<'de>,

§Example

pub fn set<T>(&mut self, key: &str, value: T) -> Result<(), Error>where T: Serialize,

§Example

pub fn delete(&mut self, key: &str) -> Option<Value>

§Example

pub fn contains_key(&self, key: &str) -> bool

§Example

pub fn get_or_create_key(&mut self) -> &str

§Example

pub fn generate_key() -> String

§Example

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

§Example

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

§Example

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

§Security

§Example

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

§Example

pub fn is_modified(&self) -> bool

§Example

pub fn is_accessed(&self) -> bool

§Example

pub fn session_key(&self) -> Option<&str>

§Example

pub fn keys(&mut self) -> Vec<String>

§Example

pub fn values(&mut self) -> Vec<&Value>

§Example

pub fn items(&mut self) -> Vec<(&String, &Value)>

§Example

pub fn clear(&mut self)

§Example

pub fn mark_modified(&mut self)

§Example

pub fn mark_unmodified(&mut self)

§Example

pub fn set_timeout(&mut self, timeout: u64)

§Example

pub fn get_timeout(&self) -> u64

§Example

pub fn update_activity(&mut self)

§Example

pub fn get_last_activity(&self) -> Option<DateTime<Utc>>

§Example

pub fn is_timed_out(&self) -> bool

§Example

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

§Example

Trait Implementations§

impl<B> Clone for Session<B>where B: Clone + SessionBackend,

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

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

Auto Trait Implementations§

impl<B> Freeze for Session<B>where B: Freeze,

impl<B> RefUnwindSafe for Session<B>where B: RefUnwindSafe,

impl<B> Send for Session<B>

impl<B> Sync for Session<B>

impl<B> Unpin for Session<B>where B: Unpin,

impl<B> UnsafeUnpin for Session<B>where B: UnsafeUnpin,

impl<B> UnwindSafe for Session<B>where B: UnwindSafe,

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Any for Twhere T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

fn type_name(&self) -> &'static str

impl<T> AnySync for Twhere T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Struct Session

impl<B> Session<B>
where B: SessionBackend,

pub fn get<T>(&mut self, key: &str) -> Result<Option<T>, Error>
where T: for<'de> Deserialize<'de>,

pub fn set<T>(&mut self, key: &str, value: T) -> Result<(), Error>
where T: Serialize,

impl<B> Clone for Session<B>
where B: Clone + SessionBackend,

impl<B> Freeze for Session<B>
where B: Freeze,

impl<B> RefUnwindSafe for Session<B>
where B: RefUnwindSafe,

impl<B> Unpin for Session<B>
where B: Unpin,

impl<B> UnsafeUnpin for Session<B>
where B: UnsafeUnpin,

impl<B> UnwindSafe for Session<B>
where B: UnwindSafe,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Any for T
where T: Any,

impl<T> AnySync for T
where T: Any + Send + Sync,

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

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

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

impl<T> CloneToUninit for T
where T: Clone,

fn conv<T>(self) -> T
where Self: Into<T>,

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

impl<T> FromRef<T> for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,