Struct Session

pub struct Session {
    pub id: Ulid,
    pub state: SessionState,
    pub created_at: DateTime<Utc>,
    pub user_id: Option<Ulid>,
    pub user_session_id: Option<Ulid>,
    pub client_id: Ulid,
    pub scope: Scope,
    pub user_agent: Option<String>,
    pub last_active_at: Option<DateTime<Utc>>,
    pub last_active_ip: Option<IpAddr>,
    pub human_name: Option<String>,
}

Fields

id: Ulid

state: SessionState

created_at: DateTime<Utc>

user_id: Option<Ulid>

user_session_id: Option<Ulid>

client_id: Ulid

scope: Scope

user_agent: Option<String>

last_active_at: Option<DateTime<Utc>>

last_active_ip: Option<IpAddr>

human_name: Option<String>

Implementations

impl Session

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

Marks the session as finished.

Parameters

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

Errors

Returns an error if the session is already finished.

Methods from Deref<Target = SessionState>

pub fn is_valid(&self) -> bool

Returns true if the session state is Valid.

pub fn is_finished(&self) -> bool

Returns true if the session state is Finished.

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

Returns the time the session was finished, if any

Returns None if the session is still Valid.

Trait Implementations

impl Clone for Session

fn clone(&self) -> Session

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Session

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

Formats the value using the given formatter.

impl Deref for Session

type Target = SessionState

The resulting type after dereferencing.

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

Dereferences the value.

impl PartialEq for Session

fn eq(&self, other: &Session) -> 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 Session

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 Session

impl StructuralPartialEq for Session