Skip to main content

TokenClaims

Struct TokenClaims 

Source
#[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),通常是用户 ID
  • aud:受众(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: String

JWT ID

Token 的唯一标识符,用于防止重放攻击

§token_type: TokenType

Token 类型

可选值:

  • TokenType::Access:访问令牌,用于 API 访问
  • TokenType::Refresh:刷新令牌,用于获取新的访问令牌
§custom: Value

自定义声明

使用 JSON 格式存储任意自定义数据,例如用户角色、权限等。 使用 #[serde(flatten)] 将自定义字段展平到 Token 的顶层。

§示例

{
  "role": "admin",
  "permissions": ["read", "write", "delete"],
  "org_id": "org_123"
}

Implementations§

Source§

impl TokenClaims

Source

pub fn new( iss: impl Into<String>, sub: impl Into<String>, aud: impl Into<String>, exp: u64, nbf: u64, iat: u64, jti: impl Into<String>, token_type: TokenType, custom: Value, ) -> Self

构造 TokenClaims(#[non_exhaustive] 后的唯一公开构造入口)。

Trait Implementations§

Source§

impl Clone for TokenClaims

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TokenClaims

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for TokenClaims

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for TokenClaims

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

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
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more