JwtClaims

Struct JwtClaims 

Source
pub struct JwtClaims {
    pub login_id: String,
    pub iss: Option<String>,
    pub aud: Option<String>,
    pub exp: Option<i64>,
    pub nbf: Option<i64>,
    pub iat: Option<i64>,
    pub jti: Option<String>,
    pub login_type: Option<String>,
    pub device: Option<String>,
    pub extra: HashMap<String, Value>,
}
Expand description

JWT Claims | JWT 声明

Standard JWT claims with sa-token extensions 标准 JWT 声明及 sa-token 扩展

Fields§

§login_id: String

Subject (user identifier) | 主题(用户标识符)

§iss: Option<String>

Issuer | 签发者

§aud: Option<String>

Audience | 受众

§exp: Option<i64>

Expiration time (Unix timestamp) | 过期时间(Unix 时间戳)

§nbf: Option<i64>

Not before time (Unix timestamp) | 生效时间(Unix 时间戳)

§iat: Option<i64>

Issued at time (Unix timestamp) | 签发时间(Unix 时间戳)

§jti: Option<String>

JWT ID (unique identifier) | JWT ID(唯一标识符)

§login_type: Option<String>

Login type (user, admin, etc.) | 登录类型(用户、管理员等)

§device: Option<String>

Device identifier | 设备标识

§extra: HashMap<String, Value>

Custom data | 自定义数据

Implementations§

Source§

impl JwtClaims

Source

pub fn new(login_id: impl Into<String>) -> JwtClaims

Create new JWT claims | 创建新的 JWT 声明

§Arguments | 参数
  • login_id - User identifier | 用户标识符
Source

pub fn set_expiration(&mut self, seconds: i64) -> &mut JwtClaims

Set expiration time in seconds from now | 设置从现在开始的过期时间(秒)

§Arguments | 参数
  • seconds - Seconds until expiration | 到期秒数
Source

pub fn set_expiration_at(&mut self, datetime: DateTime<Utc>) -> &mut JwtClaims

Set expiration at specific time | 设置具体的过期时间

Source

pub fn set_issuer(&mut self, issuer: impl Into<String>) -> &mut JwtClaims

Set issuer | 设置签发者

Source

pub fn set_audience(&mut self, audience: impl Into<String>) -> &mut JwtClaims

Set audience | 设置受众

Source

pub fn set_jti(&mut self, jti: impl Into<String>) -> &mut JwtClaims

Set JWT ID | 设置 JWT ID

Source

pub fn set_login_type( &mut self, login_type: impl Into<String>, ) -> &mut JwtClaims

Set login type | 设置登录类型

Source

pub fn set_device(&mut self, device: impl Into<String>) -> &mut JwtClaims

Set device identifier | 设置设备标识

Source

pub fn add_claim( &mut self, key: impl Into<String>, value: Value, ) -> &mut JwtClaims

Add custom claim | 添加自定义声明

Source

pub fn get_claim(&self, key: &str) -> Option<&Value>

Get custom claim | 获取自定义声明

Source

pub fn set_claims(&mut self, claims: HashMap<String, Value>) -> &mut JwtClaims

Set all custom claims at once | 一次设置所有自定义声明

Source

pub fn get_claims(&self) -> &HashMap<String, Value>

Get all custom claims | 获取所有自定义声明

Source

pub fn is_expired(&self) -> bool

Check if token is expired | 检查 token 是否过期

Source

pub fn remaining_time(&self) -> Option<i64>

Get remaining time in seconds | 获取剩余时间(秒)

Trait Implementations§

Source§

impl Clone for JwtClaims

Source§

fn clone(&self) -> JwtClaims

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for JwtClaims

Source§

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

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

impl<'de> Deserialize<'de> for JwtClaims

Source§

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

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

impl Serialize for JwtClaims

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

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

§

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
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

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
§

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

§

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Serialize for T
where T: Serialize + ?Sized,

Source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source§

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

§

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

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

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

§

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

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

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

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