RefreshTokenManager

Struct RefreshTokenManager 

Source
pub struct RefreshTokenManager { /* private fields */ }
Expand description

Refresh Token Manager | Refresh Token 管理器

Manages refresh token generation, validation, and access token renewal 管理 refresh token 的生成、验证和访问令牌的更新

Implementations§

Source§

impl RefreshTokenManager

Source

pub fn new(storage: Arc<dyn SaStorage>, config: Arc<SaTokenConfig>) -> Self

Create new refresh token manager | 创建新的 refresh token 管理器

§Arguments | 参数
  • storage - Storage backend | 存储后端
  • config - Sa-token configuration | Sa-token 配置
Source

pub fn generate(&self, login_id: &str) -> String

Generate a new refresh token | 生成新的 refresh token

§Arguments | 参数
  • login_id - User login ID | 用户登录ID
§Returns | 返回

Refresh token string | Refresh token 字符串

Source

pub async fn store( &self, refresh_token: &str, access_token: &str, login_id: &str, ) -> SaTokenResult<()>

Store refresh token with associated access token | 存储 refresh token 及其关联的访问令牌

§Arguments | 参数
  • refresh_token - Refresh token | Refresh token
  • access_token - Associated access token | 关联的访问令牌
  • login_id - User login ID | 用户登录ID
Source

pub async fn validate(&self, refresh_token: &str) -> SaTokenResult<String>

Validate refresh token | 验证 refresh token

§Arguments | 参数
  • refresh_token - Refresh token to validate | 要验证的 refresh token
§Returns | 返回

Associated login_id if valid | 如果有效则返回关联的 login_id

Source

pub async fn refresh_access_token( &self, refresh_token: &str, ) -> SaTokenResult<(TokenValue, String)>

Refresh access token using refresh token | 使用 refresh token 刷新访问令牌

§Arguments | 参数
  • refresh_token - Refresh token | Refresh token
§Returns | 返回

New access token and login_id | 新的访问令牌和 login_id

Source

pub async fn delete(&self, refresh_token: &str) -> SaTokenResult<()>

Delete refresh token | 删除 refresh token

§Arguments | 参数
  • refresh_token - Refresh token to delete | 要删除的 refresh token
Source

pub async fn get_user_refresh_tokens( &self, _login_id: &str, ) -> SaTokenResult<Vec<String>>

Get all refresh tokens for a user | 获取用户的所有 refresh token

Note: This requires storage backend to support prefix scanning 注意:这需要存储后端支持前缀扫描

Source

pub async fn revoke_all_for_user(&self, login_id: &str) -> SaTokenResult<()>

Revoke all refresh tokens for a user | 撤销用户的所有 refresh token

§Arguments | 参数
  • login_id - User login ID | 用户登录ID

Trait Implementations§

Source§

impl Clone for RefreshTokenManager

Source§

fn clone(&self) -> RefreshTokenManager

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

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
§

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