Struct PersonalSession

pub struct PersonalSession {
    pub id: Ulid,
    pub state: SessionState,
    pub owner: PersonalSessionOwner,
    pub actor_user_id: Ulid,
    pub human_name: String,
    pub scope: Scope,
    pub created_at: DateTime<Utc>,
    pub last_active_at: Option<DateTime<Utc>>,
    pub last_active_ip: Option<IpAddr>,
}

Fields

id: Ulid

state: SessionState

owner: PersonalSessionOwner

actor_user_id: Ulid

human_name: String

scope: Scope

The scope for the session, identical to OAuth 2 sessions. May or may not include a device scope (personal sessions can be deviceless).

created_at: DateTime<Utc>

last_active_at: Option<DateTime<Utc>>

last_active_ip: Option<IpAddr>

Implementations

impl PersonalSession

pub fn finish( self, revoked_at: DateTime<Utc>, ) -> Result<Self, InvalidTransitionError>

Marks the session as revoked.

Parameters

• revoked_at - The time at which the session was finished.

Errors

Returns an error if the session is already finished.

pub fn has_device(&self) -> bool

Returns whether the scope of this session contains a device scope; in other words: whether this session has a device.

Methods from Deref<Target = SessionState>

pub fn is_valid(&self) -> bool

Returns true if the session state is Valid.

pub fn is_revoked(&self) -> bool

Returns true if the session state is Revoked.

pub fn revoked_at(&self) -> Option<DateTime<Utc>>

Returns the time the session was revoked, if any

Returns None if the session is still Valid.

Trait Implementations

impl Clone for PersonalSession

fn clone(&self) -> PersonalSession

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PersonalSession

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

Formats the value using the given formatter.

impl Deref for PersonalSession

type Target = SessionState

The resulting type after dereferencing.

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

Dereferences the value.

impl PartialEq for PersonalSession

fn eq(&self, other: &PersonalSession) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PersonalSession

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PersonalSession

impl StructuralPartialEq for PersonalSession