Struct Session 

#[non_exhaustive]
pub struct Session {
    pub id: String,
    pub status: SessionStatus,
    pub last_active_organization_id: Option<String>,
    pub last_active_at: Option<i64>,
    pub expire_at: Option<i64>,
    pub current_task: Option<SessionTask>,
    pub tasks: Vec<SessionTask>,
}

Typed mirror of the fields this crate reads from a Clerk JS Session.

Construct values with Session::new and set optional fields directly; the struct is #[non_exhaustive] so new clerk-js fields can be mirrored without a breaking release.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: String

Session id, e.g. sess_2def.

status: SessionStatus

Session status, as reported by clerk-js.

last_active_organization_id: Option<String>

Active organization id for this session, as reported by clerk-js, if any. Used to invalidate server-verified org claims when the active organization changes within a session.

last_active_at: Option<i64>

Last activity (unix ms).

expire_at: Option<i64>

Expiry (unix ms).

current_task: Option<SessionTask>

The current pending session task, if the session is not yet fully active. A signed-in-but-pending session (status == "pending") carries one; apps route on it to complete the after-auth flow.

tasks: Vec<SessionTask>

All pending session tasks, in clerk-js order. clerk-js reports Array<SessionTask> | null; a null reads as no tasks.

Implementations

impl Session

pub fn new(id: impl Into<String>, status: impl Into<SessionStatus>) -> Self

Creates a session with the given id and status and all optional fields unset. Set remaining fields directly.

pub fn is_active(&self) -> bool

True when clerk-js reports the session as active.

Trait Implementations

impl Clone for Session

fn clone(&self) -> Session

Returns a duplicate 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<'de> Deserialize<'de> for Session

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Session

impl PartialEq for Session

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

Equality operator ==.

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

Inequality operator !=.

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 StructuralPartialEq for Session