Struct revolt_database::User

pub struct User {
    pub id: String,
    pub username: String,
    pub discriminator: String,
    pub display_name: Option<String>,
    pub avatar: Option<File>,
    pub relations: Option<Vec<Relationship>>,
    pub badges: Option<i32>,
    pub status: Option<UserStatus>,
    pub profile: Option<UserProfile>,
    pub flags: Option<i32>,
    pub privileged: bool,
    pub bot: Option<BotInformation>,
}

User

Fields

id: String

Unique Id

username: String

Username

discriminator: String

Discriminator

display_name: Option<String>

Display name

avatar: Option<File>

Avatar attachment

relations: Option<Vec<Relationship>>

Relationships with other users

badges: Option<i32>

Bitfield of user badges

status: Option<UserStatus>

User’s current status

profile: Option<UserProfile>

User’s profile page

flags: Option<i32>

Enum of user flags

privileged: bool

Whether this user is privileged

bot: Option<BotInformation>

Bot information

Implementations

impl User

pub fn apply_options(&mut self, optional_struct: PartialUser)

impl User

pub async fn create<I, D>( db: &Database, username: String, account_id: I, data: D, ) -> Result<User>

where I: Into<Option<String>>, D: Into<Option<PartialUser>>,

Create a new user

pub fn relationship_with(&self, user_b: &str) -> RelationshipStatus

Get the relationship with another user

pub fn is_friends_with(&self, user_b: &str) -> bool

pub async fn has_mutual_connection( &self, db: &Database, user_b: &str, ) -> Result<bool>

Check whether two users have a mutual connection

This will check if user and user_b share a server or a group.

pub async fn can_acquire_server(&self, db: &Database) -> Result<()>

Check if this user can acquire another server

pub fn validate_username(username: String) -> Result<String>

Sanitise and validate a username can be used

pub fn from_token<'life0, 'life1, 'async_recursion>( db: &'life0 Database, token: &'life1 str, hint: UserHint, ) -> Pin<Box<dyn Future<Output = Result<User>> + Send + 'async_recursion>>

where 'life0: 'async_recursion, 'life1: 'async_recursion,

Find a user from a given token and hint

pub async fn fetch_many_ids_as_mutuals( db: &Database, perspective: &User, ids: &[String], ) -> Result<Vec<User>>

Helper function to fetch many users as a mutually connected user (while optimising the online ID query)

pub async fn find_discriminator( db: &Database, username: &str, preferred: Option<(String, String)>, ) -> Result<String>

Find a free discriminator for a given username

pub async fn update_username( &mut self, db: &Database, username: String, ) -> Result<()>

Update a user’s username

pub async fn set_relationship( &mut self, db: &Database, user_b: &User, status: RelationshipStatus, ) -> Result<()>

Set a relationship to another user

pub async fn apply_relationship( &mut self, db: &Database, target: &mut User, local: RelationshipStatus, remote: RelationshipStatus, ) -> Result<()>

Apply a certain relationship between two users

pub async fn add_friend( &mut self, db: &Database, target: &mut User, ) -> Result<()>

Add another user as a friend

pub async fn remove_friend( &mut self, db: &Database, target: &mut User, ) -> Result<()>

Remove another user as a friend

pub async fn block_user( &mut self, db: &Database, target: &mut User, ) -> Result<()>

Block another user

pub async fn unblock_user( &mut self, db: &Database, target: &mut User, ) -> Result<()>

Unblock another user

pub async fn update<'a>( &mut self, db: &Database, partial: PartialUser, remove: Vec<FieldsUser>, ) -> Result<()>

Update user data

pub fn remove_field(&mut self, field: &FieldsUser)

Remove a field from User object

pub async fn mark_deleted(&mut self, db: &Database) -> Result<()>

Mark as deleted

impl User

pub async fn into<'a, P>(self, db: &Database, perspective: P) -> User

where P: Into<Option<&'a User>>,

pub fn into_known<'a, P>(self, perspective: P, is_online: bool) -> User

where P: Into<Option<&'a User>>,

Convert user object into user model assuming mutual connection

pub async fn into_self(self) -> User

pub fn as_author_for_system(&self) -> MessageAuthor<'_>

Trait Implementations

impl Clone for User

fn clone(&self) -> User

Returns a copy 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 From<User> for User

fn from(value: User) -> User

Converts to this type from the input type.

impl PartialEq for User

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

impl StructuralPartialEq for User