Skip to main content

UserSession

Struct UserSession 

Source
pub struct UserSession(/* private fields */);
Expand description

axum extractor:要求用户已登录,否则返回 401。 通过 Deref/DerefMut 可直接访问内部 Session 的所有方法。

Methods from Deref<Target = Session>§

Source

pub fn is_login(&self) -> bool

返回 true 表示用户已登录(account 非空)。

Source

pub fn can_renew(&self) -> bool

返回 true 表示 Session 尚未达到最大续期次数,可以续期。

Source

pub fn refresh(&mut self)

续期:累加续期计数并更新签发时间戳。

Source

pub fn get_account(&self) -> &str

返回当前登录的用户账号。

Source

pub fn get_user_id(&self) -> i64

返回当前登录的用户 ID。

Source

pub fn get_expired_at(&self) -> String

返回 Session 过期时间的格式化字符串。

Source

pub fn is_will_expired(&self) -> bool

返回 true 表示 Session 将在 1 小时内过期。

Source

pub fn get_issued_at(&self) -> String

返回 Session 签发时间的格式化字符串。

Source

pub fn is_expired(&self) -> bool

返回 true 表示 Session 已超过 TTL 过期。

Source

pub fn reset(&mut self)

重置 Session(登出),清除 ID 和账号信息。

Source

pub async fn save(&self) -> Result<(), Error>

将当前 Session 数据持久化到 Redis,TTL 与配置一致。

Trait Implementations§

Source§

impl Deref for UserSession

Source§

type Target = Session

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl DerefMut for UserSession

Source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
Source§

impl From<UserSession> for Session

Source§

fn from(se: UserSession) -> Self

Converts to this type from the input type.
Source§

impl<S> FromRequestParts<S> for UserSession
where S: Send + Sync,

Source§

type Rejection = Error

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

async fn from_request_parts( parts: &mut Parts, _state: &S, ) -> Result<Self, Self::Rejection>

Perform the extraction.

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S, T> FromRequest<S, ViaParts> for T
where S: Send + Sync, T: FromRequestParts<S>,

Source§

type Rejection = <T as FromRequestParts<S>>::Rejection

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

fn from_request( req: Request<Body>, state: &S, ) -> impl Future<Output = Result<T, <T as FromRequest<S, ViaParts>>::Rejection>>

Perform the extraction.
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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

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

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

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,