Struct UserState 

#[non_exhaustive]
pub struct UserState { /* private fields */ }

Current-user state that distinguishes loading, signed-out, and signed-in-without-full-browser-user states.

Fields are read through accessors (status, is_loaded, user), mirroring AuthState so every read-model snapshot in the crate shares one convention.

Implementations

impl UserState

pub fn user(&self) -> Option<&User>

Full clerk-js user details, available after browser hydration.

impl UserState

pub fn status(&self) -> AuthStatus

The explicit auth resolution status.

pub fn is_loaded(&self) -> bool

Whether clerk-js has finished loading on the client.

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

Whether a session is active.

Trait Implementations

impl Clone for UserState

fn clone(&self) -> UserState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserState

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

Formats the value using the given formatter.

impl PartialEq for UserState

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for UserState