rocket-sessions 0.0.1

trait for managing sessions on a rocket application.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

#![warn(clippy::all)]
#![doc = include_str!("../README.md")]
#[macro_use]
extern crate async_trait;

use std::fmt::{Debug, Display};
use std::time::Duration;

#[cfg(feature = "redis")]
mod redis;

#[cfg(feature = "in-memory")]
pub mod in_memory;

/// Represents a handle to the underlying data structure
/// managing sessions in a Rocket application.
/// The `id` parameter corresponds to the session token
/// stored by the client. This should correspond to a
/// random alphanumeric string of letters with sufficient entropy.
///
/// The `key` and `value` parameters can be used to set custom fields. They could
/// be used to store CRSF tokens, timestamps or some other session metadata.
#[async_trait]
pub trait SessionManager {
    type Error: Debug + Display;
    async fn set(&self, id: &str, key: &str, val: &str, time: Duration) -> Result<(), Self::Error>;
    async fn get(&self, id: &str, key: &str) -> Result<Option<String>, Self::Error>;
    async fn delete(&self, id: &str, key: &str) -> Result<(), Self::Error>;
    async fn expire_in(&self, id: &str, key: &str, time: Duration) -> Result<(), Self::Error>;
    async fn clear_all(&self) -> Result<(), Self::Error>;
}