Enum SessionStatus 

#[non_exhaustive]
pub enum SessionStatus {
    Active,
    Abandoned,
    Ended,
    Expired,
    Pending,
    Removed,
    Replaced,
    Revoked,
    Other(OtherStatus),
}

Session status as reported by clerk-js.

Serializes as the raw clerk-js status string. The enum is #[non_exhaustive]; statuses this crate has not named yet round-trip through SessionStatus::Other.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Active

The session is valid and the user is signed in.

Abandoned

The user abandoned the auth flow before the session became active.

Ended

The session ended, for example by signing out of it.

Expired

The session expired.

Pending

The session requires additional steps (for example MFA) before it is active.

Removed

The session was removed.

Replaced

The session was replaced by a newer session.

Revoked

The session was revoked.

Other(OtherStatus)

A status string this crate has not named yet.

Only produced by the From<&str>/From<String>/FromStr conversions, which canonicalize known strings to their named variants first. The payload is an OtherStatus with no public constructor, so an Other can never alias a named variant (e.g. hold "active"): reads through SessionStatus::as_str and comparisons therefore stay consistent.

Implementations

impl SessionStatus

pub fn as_str(&self) -> &str

The raw clerk-js status string.

Trait Implementations

impl Clone for SessionStatus

fn clone(&self) -> SessionStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionStatus

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SessionStatus

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SessionStatus

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

Formats the value using the given formatter.

impl Eq for SessionStatus

impl From<&str> for SessionStatus

fn from(status: &str) -> Self

Converts to this type from the input type.

impl From<SessionStatus> for String

fn from(status: SessionStatus) -> Self

Converts to this type from the input type.

impl From<String> for SessionStatus

fn from(status: String) -> Self

Converts to this type from the input type.

impl FromStr for SessionStatus

type Err = !

The associated error which can be returned from parsing.

fn from_str(status: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for SessionStatus

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SessionStatus

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SessionStatus

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 SessionStatus