Crate sa_token_plugin_salvo

Source

Expand description

Facade: pinned Salvo semver via *-v* binding crate / 门面：通过 *-v* 绑定固定 Salvo 大版本。

v079 (default | 默认): sa-token-plugin-salvo-v079 — Salvo 0.79.x.

Modules§

adapter
error_response: Shared JSON bodies for HTTP bindings (framework-agnostic core).
extractor
layer: Salvo Handler implementing the shared auth pipeline / 实现统一鉴权流水线的 Salvo Handler。
middleware
sa_token_adapter: sa-token-adapter
sa_token_core: sa-token-core

Structs§

AccessToken: Access Token Response | 访问令牌响应
AuthError: 中文: 认证错误 | English: Authentication error
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: 简单的日志监听器示例
LoginIdExtractor: 中文: 登录 ID 提取器，从请求扩展中获取 login_id English: Login ID extractor fetching login_id from request extensions
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 在线用户信息
OptionalSaTokenExtractor: 中文: 可选 Token 提取器，适用于无需强制登录的场景 English: Optional token extractor for routes without mandatory login
PathAuthConfig: Path-based authentication configuration 基于路径的鉴权配置
PushMessage: Push message structure 推送消息结构
RefreshTokenManager: Refresh Token Manager | Refresh Token 管理器
SaCheckLoginMiddleware: 中文 | English Sa-Token 登录检查中间件 | Sa-Token login check middleware
SaCheckPermissionMiddleware: 中文 | English Sa-Token 权限检查中间件 | Sa-Token permission check middleware
SaCheckRoleMiddleware: 中文 | English Sa-Token 角色检查中间件 | Sa-Token role check middleware
SaSession: Session 对象 | Session Object
SaTokenConfig: sa-token 配置
SaTokenContext: sa-token 上下文 | sa-token Context
SaTokenEvent: 事件数据
SaTokenEventBus: 事件总线 - 管理所有监听器并分发事件
SaTokenExtractor: 中文: 必填 Token 提取器，从 Salvo Request 扩展里读取 Token English: Required token extractor reading TokenValue from Salvo request extensions
SaTokenLayer: Optional PathAuthConfig: if set, should_reject → 401 without call_next. 可选 PathAuthConfig：命中拒绝条件时直接 401，不调用后续。
SaTokenManager: sa-token 管理器
SaTokenState: Shared application state (stored in Salvo [Depot] / handlers for the versioned binding).
SaTokenStateBuilder
SalvoCapturedRequest: Request-field snapshot before await for run_auth_flow / extract_token. .await 前的请求字段快照，供 run_auth_flow / extract_token 使用，避免借用 Request 跨过异步点。
SalvoRequestAdapter: 中文 | English Salvo 请求适配器 | Salvo request adapter
SalvoResponseAdapter: 中文 | English Salvo 响应适配器 | Salvo response adapter
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§

auth_middleware: 中文 | English 认证中间件 - 验证用户登录状态 | Authentication middleware - verify user login status
create_context: Create SaTokenContext from authentication result 从鉴权结果创建SaTokenContext
extract_token: Generic token extraction from any SaRequest implementation. 从任意 SaRequest 实现中按统一顺序提取 Token。
extract_token_from_request: Extract token using snapshot + router helper (compatible with middleware code paths). 快照 + router 助手提取 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 判断路径是否需要鉴权
permission_middleware: 中文 | English 权限验证中间件 - 验证用户是否拥有指定权限 | Permission middleware - verify if user has specified permissions
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_login: 检查登录状态的宏
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_ignore: 忽略认证检查的宏

Crate sa_token_plugin_salvo

Crate sa_token_plugin_salvo Copy item path

Modules§

Structs§

Enums§

Traits§

Functions§

Type Aliases§

Attribute Macros§

Crate sa_token_plugin_salvo