Struct User 

pub struct User {

    pub id: usize,
    pub created: usize,
    pub username: String,
    pub password: String,
    pub salt: String,
    pub settings: UserSettings,
    pub tokens: Vec<Token>,
    pub permissions: Vec<UserPermission>,
    pub is_verified: bool,
    pub notification_count: usize,
    pub totp: String,
    pub recovery_codes: Vec<String>,
    pub stripe_id: String,
    pub ban_reason: String,
    pub ban_expire: usize,
    pub is_deactivated: bool,
    pub checkouts: Vec<String>,
    pub last_policy_consent: usize,
    pub linked_accounts: UserLinkedAccounts,
    pub badges: Vec<UserBadge>,
    pub principal_org: usize,
    pub org_as_tenant: bool,
    pub org_creation_credits: i32,
    pub org_user_register_credits: i32,
}

Fields

id: usize

created: usize

username: String

password: String

salt: String

settings: UserSettings

tokens: Vec<Token>

permissions: Vec<UserPermission>

is_verified: bool

notification_count: usize

totp: String

The TOTP secret for this profile. An empty value means the user has TOTP disabled.

recovery_codes: Vec<String>

The TOTP recovery codes for this profile.

stripe_id: String

The user’s Stripe customer ID.

ban_reason: String

The reason the user was banned.

ban_expire: usize

The time at which the user’s ban will automatically expire.

is_deactivated: bool

If the user is deactivated. Deactivated users act almost like deleted users, but their data is not wiped.

checkouts: Vec<String>

The IDs of Stripe checkout sessions that this user has successfully completed.

This should be checked BEFORE applying purchases to ensure that the user hasn’t already applied this purchase.

last_policy_consent: usize

The time in which the user last consented to the site’s policies.

linked_accounts: UserLinkedAccounts

The other accounts in the database that are linked to this account.

badges: Vec<UserBadge>

A list of the user’s profile badges.

principal_org: usize

The ID of the user’s principal organization (i.e. the organization shown on their profile).

org_as_tenant: bool

If the user is locked into their principal organization. Their organization’s owner can manage their account if this is true.

org_creation_credits: i32

The number of organizations the user can create.

org_user_register_credits: i32

The number of users the user can register to an organization.

Implementations

impl User

pub fn new(username: String, password: String) -> Self

Create a new User.

pub fn deleted() -> Self

Deleted user profile.

pub fn banned() -> Self

Banned user profile.

pub fn create_token(ip: &str) -> (String, Token)

Create a new token

Returns

(unhashed id, token)

pub fn check_password(&self, against: String) -> bool

Check if the given password is correct for the user.

pub fn totp(&self, issuer: Option<String>) -> Option<TOTP>

Get a TOTP from the profile’s totp secret value.

pub fn clean(&mut self)

Clean the struct for public viewing.

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 Default for User

fn default() -> Self

Returns the “default value” for a type.

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 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.