Struct Session 

pub struct Session { /* private fields */ }

会话实例 — 对齐 PHP think\Session

每个 Session 实例绑定一个 session_id，通过 SessionStore 后端 读写数据。实例本身不缓存数据，每次操作都直接访问后端（对齐 PHP 行为）。

用法

use sz_rust_state_facade::session::{Session, MemorySessionStore};
use serde_json::json;

let store = MemorySessionStore::new();
let session = Session::new("session-id-123", store);

session.set("user_id", json!(12345));
assert_eq!(session.get("user_id"), Some(json!(12345)));
assert!(session.has("user_id"));

Implementations

impl Session

pub fn new( session_id: impl Into<String>, store: impl SessionStore + 'static, ) -> Session

创建新的会话实例

参数

• session_id：会话唯一标识（通常由中间件从 Cookie 中提取或新生成）
• store：存储后端（如 MemorySessionStore)

pub fn with_shared_store( session_id: impl Into<String>, store: Arc<dyn SessionStore>, ) -> Session

从 Arc<dyn SessionStore> 创建会话（共享后端实例）

pub fn with_prefix(self, prefix: impl Into<String>) -> Session

设置键前缀（对齐 PHP think\Session::prefix($prefix)）

设置后，所有 set/get/delete/has 操作都会自动添加此前缀。 用于在同一 session_id 下实现命名空间隔离。

pub fn session_id(&self) -> &str

获取当前会话 ID

pub fn set(&self, name: &str, value: Value)

设置会话数据（对齐 PHP Session::set($name, $value)）

PHP 对齐

public function set(string $name, $value): void

pub fn get(&self, name: &str) -> Option<Value>

获取会话数据（对齐 PHP Session::get($name = null, $default = null)）

返回

• Some(value)：键存在
• None：键不存在

pub fn get_with_default(&self, name: &str, default: Value) -> Value

获取会话数据，键不存在时返回默认值

对齐 PHP Session::get($name, $default)。

pub fn has(&self, name: &str) -> bool

检查会话数据是否存在（对齐 PHP Session::has($name)）

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

删除会话数据（对齐 PHP Session::delete($name)）

返回被删除的值（对齐 PHP 行为：删除不存在的键返回 null）。

pub fn clear(&self)

清空当前会话的所有数据（对齐 PHP Session::clear()）

注意：此操作会删除整个 session_id 对应的数据，包括 flash 数据。

pub fn flash(&self, name: &str, value: Value)

设置 flash 数据（对齐 PHP Session::flash($name, $value)）

Flash 数据在设置后，于下次调用 Session::clear_flash 时被清除。 通常由中间件在请求结束时调用 clear_flash。

实现说明

使用 __flash__: 前缀标记 flash 数据，与普通数据隔离存储。

pub fn get_flash(&self, name: &str) -> Option<Value>

获取 flash 数据

与 Session::get 类似，但自动添加 flash 前缀。

pub fn clear_flash(&self)

清除所有 flash 数据（对齐 PHP think\session\Driver::clearFlashData()）

应在请求结束时由中间件调用，以实现 flash 数据的“一次性“语义。

pub fn flush(&self)

清空所有数据并销毁 session（对齐 PHP Session::flush()）

与 Session::clear 的区别：flush 同时清除 flash 数据， 行为上等价于 clear（因为 clear 直接销毁整个 session）。

pub fn all(&self) -> HashMap<String, Value>

获取当前会话的所有数据（不含 flash 数据）

对齐 PHP Session::all()。