Enum AuthStatus 

#[non_exhaustive]
pub enum AuthStatus {
    Loading,
    SignedOut,
    SignedIn,
}

Resolved authentication status for app-facing rendering decisions.

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.

Loading

Clerk has not supplied a reliable auth answer yet.

SignedOut

Clerk has resolved and no active session is known.

SignedIn

A signed-in session is known, either from SSR initial state or clerk-js.

Implementations

impl AuthStatus

pub fn is_loading(self) -> bool

True while auth has not resolved to signed-in or signed-out yet.

pub fn is_signed_out(self) -> bool

True only when auth has resolved and no active session is known.

pub fn is_signed_in(self) -> bool

True when a signed-in session is known.

Trait Implementations

impl Clone for AuthStatus

fn clone(&self) -> AuthStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AuthStatus

impl Debug for AuthStatus

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

Formats the value using the given formatter.

impl Default for AuthStatus

fn default() -> AuthStatus

Returns the “default value” for a type.

impl Eq for AuthStatus

impl Hash for AuthStatus

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 AuthStatus

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AuthStatus