Crate sa_token_plugin_rocket 

Facade: selects the Rocket semver binding crate via features. 门面：通过 feature 选择 Rocket 语义版本绑定 crate。

• v05 (default | 默认): sa-token-plugin-rocket-v05 — Rocket 0.5.x.

Modules

adapter

Rocket request/response adapters for SaRequest / SaResponse. Rocket 请求／响应适配器，实现 SaRequest / SaResponse。

error_response

Shared JSON bodies for HTTP bindings (framework-agnostic core).

extractor

Rocket Request Guards (提取器)

layer

SaTokenLayer Fairing: runs shared run_auth_flow, then sets SaTokenContext / clears after response. SaTokenLayer Fairing：执行统一的 run_auth_flow，设置 SaTokenContext，响应后清理。

middleware

Rocket Fairings sharing the same run_auth_flow rules as SaTokenLayer (see each on_request). 与 SaTokenLayer 共用 run_auth_flow 规则的 Fairing（详见各 on_request）。

sa_token_core

sa-token-core

Structs

AccessToken

Access Token Response | 访问令牌响应

AuthFlowResult

Outcome of run_auth_flow; bindings copy token/login_id/context into framework-specific storage (extensions, depot, etc.). run_auth_flow 的返回结果；各框架绑定把 token / login_id / context 写入自身存储（extensions、Depot 等）。

AuthResult

Authentication result after processing 处理后的鉴权结果

AuthorizationCode

Authorization Code | 授权码

DefaultWsTokenExtractor

Default token extractor implementation 默认的 Token 提取器实现

DistributedSession

Distributed session data structure 分布式 Session 数据结构

DistributedSessionManager

Distributed session manager 分布式 Session 管理器

InMemoryDistributedStorage

In-memory distributed session storage implementation 内存分布式 Session 存储实现

InMemoryPusher

In-memory message pusher implementation 内存消息推送器实现

JwtClaims

JWT Claims | JWT 声明

JwtManager

JWT Manager | JWT 管理器

LoggingListener

简单的日志监听器示例

LoginIdGuard

LoginId 守卫 - 直接获取登录用户的 ID

MemoryStorage

内存存储实现

NonceManager

Nonce Manager | Nonce 管理器

OAuth2Client

OAuth2 Client Information | OAuth2 客户端信息

OAuth2Manager

OAuth2 Manager | OAuth2 管理器

OAuth2TokenInfo

OAuth2 Token Information (for storage) | OAuth2 令牌信息（用于存储）

OnlineManager

Online user manager 在线用户管理器

OnlineUser

Online user information 在线用户信息

OptionalSaTokenGuard

可选 Token 守卫 - 不存在也不报错

PathAuthConfig

Path-based authentication configuration 基于路径的鉴权配置

PushMessage

Push message structure 推送消息结构

RefreshTokenManager

Refresh Token Manager | Refresh Token 管理器

RocketRequestAdapter

Borrows Rocket Request for synchronous SaRequest use (caller must not hold across .await with incompatible lifetimes). 借用 Rocket Request 实现同步 SaRequest（注意不要在不兼容的生命周期下跨 .await 持有）。

RocketResponseAdapter

Rocket 响应适配器

SaCheckLoginFairing

sa-token 登录检查 Fairing - 强制要求登录

SaCheckPermissionFairing

sa-token 权限检查 Fairing - 强制要求特定权限

SaCheckRoleFairing

sa-token 角色检查 Fairing - 强制要求特定角色

SaCtx

请求级 SaTokenContext（来自 Fairing 写入的 local_cache，跨 await 安全）。

SaLogic

绑定某一 login_type 的账号逻辑门面

SaSession

Session 对象 | Session Object

SaStorageDistributedStorage

基于 SaStorage 的分布式 Session 存储实现 把分布式 Session、登录索引、服务凭证统一持久化到任意 SaStorage 后端（Redis / 内存 / 数据库）

SaTerminalInfo

登录设备终端信息

SaTokenConfig

sa-token 配置

SaTokenContext

sa-token 上下文 | sa-token Context

SaTokenEvent

事件数据

SaTokenEventBus

事件总线 - 管理所有监听器并分发事件

SaTokenFairing

sa-token Fairing - 提取并验证 token

SaTokenGuard

Token 守卫 - 必须存在，否则返回错误

SaTokenLayer

Rocket Fairing using RocketCapturedRequest + run_auth_flow (rocket-core pipeline). 使用 RocketCapturedRequest + run_auth_flow（rocket-core 流水线）的 Fairing。

SaTokenManager

sa-token 管理器

SaTokenState

Shared application state (register with [rocket::manage] in the v0.5 binding).

SaTokenStateBuilder

ServiceCredential

Service credential for inter-service authentication 服务间认证的服务凭证

SsoClient

SSO 客户端 | SSO Client

SsoConfig

SsoManager

SsoServer

SSO 服务端 | SSO Server

SsoSession

SSO 全局会话 | SSO Global Session

SsoTicket

SSO 票据结构 | SSO Ticket Structure

StpUtil

StpUtil - 权限认证工具类

TokenInfo

Token 信息 | Token Information

TokenValue

Token 值

WsAuthInfo

WebSocket authentication information WebSocket 认证信息

WsAuthManager

WebSocket authentication manager WebSocket 认证管理器

Enums

JwtAlgorithm

JWT Algorithm | JWT 算法

MessageType

Message type enumeration 消息类型枚举

SaTokenError

SaTokenEventType

事件类型

TokenStyle

Token 风格 | Token Style

Traits

DistributedSessionStorage

Distributed session storage trait 分布式 Session 存储 trait

FrameworkAdapter

框架适配器trait

LoginId

LoginId trait - 支持任何可以转换为字符串的类型作为登录 ID

MessagePusher

Message pusher trait 消息推送器 trait

PermissionChecker

权限检查器 | Permission Checker

SaStorage

存储适配器trait

SaTokenListener

事件监听器 trait | Event Listener Trait

WsTokenExtractor

Token extractor trait for WebSocket connections WebSocket 连接的 Token 提取器 trait

Functions

create_context

Create SaTokenContext from authentication result 从鉴权结果创建SaTokenContext

extract_token

Generic token extraction from any SaRequest implementation. 从任意 SaRequest 实现中按统一顺序提取 Token。

match_any

Check if path matches any pattern in the list 检查路径是否匹配列表中的任意模式

match_path

Match a path against a pattern (Ant-style wildcard) 匹配路径与模式（Ant 风格通配符）

need_auth

Determine if authentication is needed for a path 判断路径是否需要鉴权

process_auth

Process authentication for a request path 处理请求路径的鉴权

run_auth_flow

Full auth pipeline: extract_token → optional PathAuthConfig via process_auth, else default check → create_context. 完整鉴权流水线：extract_token → 若有 PathAuthConfig 则 process_auth，否则默认校验 → create_context。

Type Aliases

SaTokenResult

Attribute Macros

sa_check_disable

检查账号封禁

sa_check_login

检查登录状态的宏

sa_check_or

组合鉴权（OR）：任一子检查通过即可

sa_check_permission

检查权限的宏

sa_check_permissions_and

同时检查多个权限（AND逻辑）

sa_check_permissions_or

同时检查多个权限（OR逻辑）

sa_check_role

检查角色的宏

sa_check_roles_and

同时检查多个角色（AND逻辑）

sa_check_roles_or

同时检查多个角色（OR逻辑）

sa_check_safe

检查二级认证

sa_ignore

忽略认证检查的宏