#[non_exhaustive]pub struct TokenClaims {
pub iss: String,
pub sub: String,
pub aud: String,
pub exp: u64,
pub nbf: u64,
pub iat: u64,
pub jti: String,
pub token_type: TokenType,
pub custom: Value,
}Expand description
Token 声明
JWT Token 的标准声明和自定义声明。
§标准声明字段
iss:签发者(Issuer)sub:主题(Subject),通常是用户 IDaud:受众(Audience)exp:过期时间(Expiration Time),Unix 时间戳nbf:生效时间(Not Before),Unix 时间戳iat:签发时间(Issued At),Unix 时间戳jti:JWT ID,唯一标识符
§自定义字段
token_type:Token 类型(access 或 refresh)custom:自定义声明,使用 JSON 格式存储任意数据
§示例
use yang_base::token::{TokenClaims, TokenType};
use serde_json::json;
let claims = TokenClaims::new(
"yang-base",
"user_123",
"yang-app",
1234567890,
1234567800,
1234567800,
"unique-token-id",
TokenType::Access,
json!({
"role": "admin",
"permissions": ["read", "write"]
}),
);标注 #[non_exhaustive]:未来新增字段不构成破坏性变更。
请使用 TokenClaims::new 构造。
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.iss: String签发者(Issuer)
标识 Token 的签发方,用于验证 Token 来源
sub: String主题(Subject)
通常是用户 ID 或其他唯一标识符
aud: String受众(Audience)
标识 Token 的目标接收方
exp: u64过期时间(Expiration Time)
Unix 时间戳,表示 Token 的过期时间
nbf: u64生效时间(Not Before)
Unix 时间戳,表示 Token 在此时间之前不可用
iat: u64签发时间(Issued At)
Unix 时间戳,表示 Token 的签发时间
jti: StringJWT ID
Token 的唯一标识符,用于防止重放攻击
token_type: TokenTypeToken 类型
可选值:
TokenType::Access:访问令牌,用于 API 访问TokenType::Refresh:刷新令牌,用于获取新的访问令牌
custom: Value自定义声明
使用 JSON 格式存储任意自定义数据,例如用户角色、权限等。
使用 #[serde(flatten)] 将自定义字段展平到 Token 的顶层。
§示例
{
"role": "admin",
"permissions": ["read", "write", "delete"],
"org_id": "org_123"
}Implementations§
Trait Implementations§
Source§impl Clone for TokenClaims
impl Clone for TokenClaims
Source§impl Debug for TokenClaims
impl Debug for TokenClaims
Source§impl<'de> Deserialize<'de> for TokenClaims
impl<'de> Deserialize<'de> for TokenClaims
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations§
impl Forget for TokenClaims
impl Freeze for TokenClaims
impl Move for TokenClaims
impl RefUnwindSafe for TokenClaims
impl Send for TokenClaims
impl Sync for TokenClaims
impl Unpin for TokenClaims
impl UnsafeUnpin for TokenClaims
impl UnwindSafe for TokenClaims
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more