Struct SaTokenManager 

pub struct SaTokenManager {
    pub config: SaTokenConfig,
    /* private fields */
}

sa-token 管理器

Fields

config: SaTokenConfig

配置信息

Implementations

impl SaTokenManager

pub async fn disable_level( &self, login_id: &str, service: &str, level: i32, time: i64, ) -> Result<(), SaTokenError>

封禁指定账号的指定服务及等级

time 单位为秒，-1 表示永久封禁。

pub async fn disable( &self, login_id: &str, time: i64, ) -> Result<(), SaTokenError>

封禁指定账号（默认服务 login、默认等级）

pub async fn get_disable_level( &self, login_id: &str, service: &str, ) -> Result<i32, SaTokenError>

获取封禁等级；未封禁返回 NOT_DISABLE_LEVEL

pub async fn is_disable_level( &self, login_id: &str, service: &str, level: i32, ) -> Result<bool, SaTokenError>

是否已被封禁到指定等级（含更高等级）

pub async fn check_disable_level( &self, login_id: &str, service: &str, level: i32, ) -> Result<(), SaTokenError>

校验封禁；若等级达到阈值则抛出 SaTokenError::DisableService

pub async fn check_disable_services( &self, login_id: &str, services: &[&str], level: i32, ) -> Result<(), SaTokenError>

校验多个服务的封禁（全部通过才算通过）

pub async fn untie_disable( &self, login_id: &str, service: &str, ) -> Result<(), SaTokenError>

解封指定服务

impl SaTokenManager

pub async fn open_safe( &self, token: &TokenValue, service: &str, safe_time: i64, ) -> Result<(), SaTokenError>

为指定 token 开启二级认证

pub async fn is_safe( &self, token: &TokenValue, service: &str, ) -> Result<bool, SaTokenError>

判断 token 是否已通过指定业务的二级认证

pub async fn check_safe( &self, token: &TokenValue, service: &str, ) -> Result<(), SaTokenError>

校验二级认证；未通过抛出 SaTokenError::NotSafe

pub async fn close_safe( &self, token: &TokenValue, service: &str, ) -> Result<(), SaTokenError>

关闭二级认证

pub async fn get_safe_time( &self, token: &TokenValue, service: &str, ) -> Result<Option<i64>, SaTokenError>

获取二级认证剩余有效时间（秒）；未认证返回 None

impl SaTokenManager

pub async fn get_token_session( &self, token: &TokenValue, ) -> Result<SaSession, SaTokenError>

获取 Token-Session（不存在时按配置创建）

pub async fn get_anon_token_session( &self, token: &TokenValue, ) -> Result<SaSession, SaTokenError>

匿名 Token-Session（不校验登录）

pub async fn save_token_session( &self, token: &TokenValue, session: &SaSession, ) -> Result<(), SaTokenError>

pub async fn delete_token_session( &self, token: &TokenValue, ) -> Result<(), SaTokenError>

impl SaTokenManager

pub fn new(storage: Arc<dyn SaStorage>, config: SaTokenConfig) -> SaTokenManager

创建新的管理器实例

pub fn with_stp_interface(self, iface: Arc<dyn StpInterface>) -> SaTokenManager

pub fn with_online_manager(self, manager: Arc<OnlineManager>) -> SaTokenManager

pub fn with_distributed_manager( self, manager: Arc<DistributedSessionManager>, ) -> SaTokenManager

pub fn online_manager(&self) -> Option<&Arc<OnlineManager>>

pub fn distributed_manager(&self) -> Option<&Arc<DistributedSessionManager>>

pub fn event_bus(&self) -> &SaTokenEventBus

获取事件总线的引用

pub async fn login( &self, login_id: impl Into<String>, ) -> Result<TokenValue, SaTokenError>

登录：为指定账号创建 token

pub async fn login_with_options( &self, login_id: impl Into<String>, login_type: Option<String>, device: Option<String>, extra_data: Option<Value>, nonce: Option<String>, expire_time: Option<DateTime<Utc>>, ) -> Result<TokenValue, SaTokenError>

登录：为指定账号创建 token（支持自定义 TokenInfo 字段）

参数 | Parameters

• login_id - 登录用户 ID | Login user ID
• login_type - 登录类型（如 “user”, “admin”）| Login type (e.g., “user”, “admin”)
• device - 设备标识 | Device identifier
• extra_data - 额外数据 | Extra data
• nonce - 防重放攻击的一次性令牌 | One-time token for replay attack prevention
• expire_time - 自定义过期时间（如果为 None，则使用配置的过期时间）| Custom expiration time (if None, use configured timeout)

示例 | Example

let token = manager.login_with_options(
    "user_123",
    Some("admin".to_string()),
    Some("iPhone".to_string()),
    Some(json!({"ip": "192.168.1.1"})),
    Some("nonce_123".to_string()),
    None,
).await?;

pub async fn login_with_token_info( &self, token_info: TokenInfo, ) -> Result<TokenValue, SaTokenError>

登录：使用完整的 TokenInfo 对象创建 token

参数 | Parameters

• token_info - 完整的 TokenInfo 对象，包含所有 token 信息 | Complete TokenInfo object containing all token information

说明 | Notes

• TokenInfo 中的 token 字段将被使用（如果已设置），否则会自动生成
• TokenInfo 中的 login_id 字段必须设置
• 如果 expire_time 为 None，将使用配置的过期时间
• The token field in TokenInfo will be used (if set), otherwise will be auto-generated
• The login_id field in TokenInfo must be set
• If expire_time is None, will use configured timeout

示例 | Example

use sa_token_core::token::{TokenInfo, TokenValue};
use chrono::Utc;
 
let mut token_info = TokenInfo::new(
    TokenValue::new("custom_token_123"),
    "user_123"
);
token_info.login_type = "admin".to_string();
token_info.device = Some("iPhone".to_string());
token_info.extra_data = Some(json!({"ip": "192.168.1.1"}));
 
let token = manager.login_with_token_info(token_info).await?;

pub async fn logout(&self, token: &TokenValue) -> Result<(), SaTokenError>

登出：删除指定 token（LOGOUT 模式）

pub async fn kick_out_by_token( &self, token: &TokenValue, ) -> Result<(), SaTokenError>

踢人下线（KICKOUT 模式：保留映射标记 -5）

pub async fn replaced_by_token( &self, token: &TokenValue, ) -> Result<(), SaTokenError>

顶号下线（REPLACED 模式：保留映射标记 -4）

pub async fn logout_by_login_id( &self, login_id: &str, ) -> Result<(), SaTokenError>

根据登录 ID 登出所有 token

pub async fn get_token_info( &self, token: &TokenValue, ) -> Result<TokenInfo, SaTokenError>

获取 token 信息

pub async fn is_valid(&self, token: &TokenValue) -> bool

检查 token 是否有效

pub async fn get_session( &self, login_id: &str, ) -> Result<SaSession, SaTokenError>

获取 session

pub async fn save_session( &self, session: &SaSession, ) -> Result<(), SaTokenError>

保存 session

pub async fn delete_session(&self, login_id: &str) -> Result<(), SaTokenError>

删除 session

pub async fn renew_timeout( &self, token: &TokenValue, timeout_seconds: i64, ) -> Result<(), SaTokenError>

续期 token（重置过期时间）

pub async fn kick_out(&self, login_id: &str) -> Result<(), SaTokenError>

踢人下线（按 login_id，对该账号所有 token 执行 KICKOUT）

pub async fn get_terminal_list( &self, login_type: &str, login_id: &str, device_type: Option<&str>, ) -> Result<Vec<SaTerminalInfo>, SaTokenError>

获取指定账号已登录设备终端列表

pub async fn get_token_value_list_by_login_id( &self, login_type: &str, login_id: &str, device_type: Option<&str>, ) -> Result<Vec<String>, SaTokenError>

获取指定账号的 token 列表（来自终端列表）

pub async fn get_terminal_info_by_token( &self, token: &TokenValue, ) -> Result<Option<SaTerminalInfo>, SaTokenError>

按 token 反查终端信息

impl SaTokenManager

pub async fn get_permissions_with_type( &self, login_type: &str, login_id: &str, ) -> Result<Vec<String>, SaTokenError>

pub async fn set_permissions_with_type( &self, login_type: &str, login_id: &str, permissions: Vec<String>, ) -> Result<(), SaTokenError>

pub async fn get_roles_with_type( &self, login_type: &str, login_id: &str, ) -> Result<Vec<String>, SaTokenError>

pub async fn set_roles_with_type( &self, login_type: &str, login_id: &str, roles: Vec<String>, ) -> Result<(), SaTokenError>

pub async fn set_permissions( &self, login_id: &str, permissions: Vec<String>, ) -> Result<(), SaTokenError>

覆盖设置用户权限列表 会完全替换该用户的所有权限

pub async fn get_permissions( &self, login_id: &str, ) -> Result<Vec<String>, SaTokenError>

获取用户全部权限列表 用户不存在或无权限时返回空列表

pub async fn add_permission( &self, login_id: &str, permission: String, ) -> Result<(), SaTokenError>

追加单个权限（已存在则跳过，避免重复） 采用读-改-写模式，分布式高并发下存在竞态风险

pub async fn remove_permission( &self, login_id: &str, permission: &str, ) -> Result<(), SaTokenError>

移除用户的某个权限 不存在时无操作，仅在确实删除了元素时才回写存储

pub async fn clear_permissions( &self, login_id: &str, ) -> Result<(), SaTokenError>

清除用户的全部权限 直接删除对应存储键

pub async fn set_roles( &self, login_id: &str, roles: Vec<String>, ) -> Result<(), SaTokenError>

覆盖设置用户角色列表 会完全替换该用户的所有角色

pub async fn get_roles( &self, login_id: &str, ) -> Result<Vec<String>, SaTokenError>

获取用户全部角色列表 用户不存在或无角色时返回空列表

pub async fn add_role( &self, login_id: &str, role: String, ) -> Result<(), SaTokenError>

追加单个角色（已存在则跳过，避免重复） 采用读-改-写模式，分布式高并发下存在竞态风险

pub async fn remove_role( &self, login_id: &str, role: &str, ) -> Result<(), SaTokenError>

移除用户的某个角色 不存在时无操作，仅在确实删除了元素时才回写存储

pub async fn clear_roles(&self, login_id: &str) -> Result<(), SaTokenError>

清除用户的全部角色 直接删除对应存储键

Trait Implementations

impl Clone for SaTokenManager

fn clone(&self) -> SaTokenManager

Returns a duplicate of the value.

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

Performs copy-assignment from source.