Struct User 

#[non_exhaustive]
pub struct User {
    pub id: String,
    pub first_name: Option<String>,
    pub last_name: Option<String>,
    pub primary_email_address: Option<String>,
    pub image_url: Option<String>,
}

Typed mirror of the fields this crate reads from a Clerk JS User. Unknown fields are ignored on deserialize. Use dioxus_clerk::use_clerk() for supported browser actions, or application JS for fields not mirrored here.

Construct values with User::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

Clerk user id, e.g. user_2abc.

first_name: Option<String>

First name.

last_name: Option<String>

Last name.

primary_email_address: Option<String>

Primary email address, serialized string-form.

Deserialization also accepts clerk-js’s object form ({ "emailAddress": "..." }), extracting the address string.

image_url: Option<String>

Avatar URL.

Implementations

impl User

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

Creates a user with the given Clerk user id and all optional fields unset. Set remaining fields directly.

Trait Implementations

impl Clone for User

fn clone(&self) -> User

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for User

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for User

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for User

impl PartialEq for User

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for User

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 User