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: FinePermission,
    pub is_verified: bool,
    pub notification_count: usize,
    pub follower_count: usize,
    pub following_count: usize,
    pub last_seen: usize,
    pub totp: String,
    pub recovery_codes: Vec<String>,
    pub post_count: usize,
    pub request_count: usize,
    pub connections: UserConnections,
    pub stripe_id: String,
    pub grants: Vec<AuthGrant>,
    pub associated: Vec<usize>,
    pub invite_code: usize,
    pub secondary_permissions: SecondaryPermission,
    pub achievements: Vec<Achievement>,
    pub awaiting_purchase: bool,
    pub was_purchased: bool,
    pub browser_session: String,
    pub ban_reason: String,
    pub channel_mutes: Vec<usize>,
    pub is_deactivated: bool,
    pub ban_expire: usize,
    pub coins: i32,
    pub checkouts: Vec<String>,
    pub applied_configurations: Vec<(AppliedConfigType, usize)>,
    pub last_policy_consent: usize,
}

Fields

id: usize

created: usize

username: String

password: String

salt: String

settings: UserSettings

tokens: Vec<Token>

permissions: FinePermission

is_verified: bool

notification_count: usize

follower_count: usize

following_count: usize

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

post_count: usize

request_count: usize

connections: UserConnections

External service connection details.

stripe_id: String

The user’s Stripe customer ID.

grants: Vec<AuthGrant>

The grants associated with the user’s account.

associated: Vec<usize>

A list of the IDs of all accounts the user has signed into through the UI.

invite_code: usize

The ID of the InviteCode this user provided during registration.

secondary_permissions: SecondaryPermission

Secondary permissions because the regular permissions struct ran out of possible bits.

achievements: Vec<Achievement>

Users collect achievements through little actions across the site.

awaiting_purchase: bool

If the account was registered as a “bought” account, the user should not be allowed to actually use the account if they haven’t paid for supporter yet.

was_purchased: bool

This value cannot be changed after account creation. This value is used to lock the user’s account again if the subscription is cancelled and they haven’t used an invite code.

browser_session: String

This value is updated for every new littleweb browser session.

This means the user can only have one of these sessions open at once (unless this token is stored somewhere with a way to say we already have one, but this does not happen yet).

Without this token, the user can still use the browser, they just cannot view pages which require authentication (all $ routes).

ban_reason: String

The reason the user was banned.

channel_mutes: Vec<usize>

IDs of channels the user has muted.

is_deactivated: bool

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

ban_expire: usize

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

coins: i32

The number of coins the user has.

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.

applied_configurations: Vec<(AppliedConfigType, usize)>

The IDs of products to be applied to the user’s profile.

last_policy_consent: usize

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

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 anonymous() -> Self

Anonymous 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 parse_mentions(input: &str) -> Vec<String>

Parse user mentions in a given input.

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.

pub fn get_grant_by_app_id(&self, id: usize) -> Option<&AuthGrant>

Get a grant from the user given the grant’s app ID.

Should be used before adding another grant (to ensure the app doesn’t already have a grant for this user).

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.