Struct Database

pub struct Database {
    pub base: StarterDatabase,
    pub config: ServerOptions,
    pub http: Client,
    pub citrus: CitrusClient,
}

Database connector

Fields

base: StarterDatabase

config: ServerOptions

http: Client

citrus: CitrusClient

Implementations

impl Database

pub async fn new( database_options: DatabaseOpts, server_options: ServerOptions, ) -> Self

Create a new Database

pub fn env_options() -> DatabaseOpts

Pull databeam::DatabaseOpts from env

pub async fn init(&self)

Init database

pub fn collect_split_without_stupid_reference( input: Split<'_, &str>, ) -> Vec<String>

Collect from Split<&str> while cloning everything

pub async fn audit(&self, actor_id: String, content: String) -> Result<()>

Create a moderator audit log entry

pub async fn get_profile(&self, id: String) -> Result<Box<Profile>>

Fetch a profile correctly

pub async fn get_profile_by_hashed( &self, hashed: String, ) -> Result<Box<Profile>>

Get a Profile by their hashed ID

Arguments:

• hashed - String of the profile’s hashed ID

pub async fn get_profile_by_unhashed( &self, unhashed: String, ) -> Result<Box<Profile>>

Get a user by their unhashed ID (hashes ID and then calls Database::get_profile_by_hashed())

Arguments:

• unhashed - String of the user’s unhashed ID

pub async fn get_profile_by_ip(&self, ip: String) -> Result<Box<Profile>>

Get a Profile by their IP

Arguments:

• hashed - String of the profile’s IP

pub async fn get_profile_by_username_password( &self, username: String, password: String, ) -> Result<Profile>

Get a user by their unhashed secondary token

Arguments:

• unhashed - String of the user’s unhashed secondary token

pub async fn get_profile_by_username( &self, username: String, ) -> Result<Box<Profile>>

Get a user by their username

Arguments:

• username - String of the user’s username

pub async fn get_profile_by_id(&self, id: String) -> Result<Box<Profile>>

Get a user by their id

Arguments:

• id - String of the user’s username

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

Validate a username

pub async fn create_profile( &self, props: ProfileCreate, user_ip: String, ) -> Result<String>

Create a new user given their username. Returns their unhashed token

Arguments:

• username - String of the user’s username
• user_ip - the ip address of the user registering

pub fn allowed_custom_keys(&self) -> Vec<&'static str>

pub async fn update_profile_metadata( &self, id: String, metadata: ProfileMetadata, ) -> Result<()>

Update a Profile’s metadata by its id

pub async fn update_profile_tokens( &self, id: String, tokens: Vec<String>, ips: Vec<String>, token_context: Vec<TokenContext>, ) -> Result<()>

Update a Profile’s tokens (and IPs/token_contexts) by its id

pub async fn update_profile_badges( &self, id: String, badges: Vec<(String, String, String)>, ) -> Result<()>

Update a Profile’s badges by its id

pub async fn update_profile_labels( &self, id: String, labels: Vec<String>, ) -> Result<()>

Update a Profile’s labels by its id

pub async fn update_profile_tier(&self, id: String, tier: i32) -> Result<()>

Update a Profile’s tier by its ID

pub async fn update_profile_group(&self, id: String, group: i32) -> Result<()>

Update a Profile’s gid by its id

pub async fn update_profile_password( &self, id: String, password: String, new_password: String, do_password_check: bool, ) -> Result<()>

Update a Profile’s password by its name and password

pub async fn update_profile_username( &self, id: String, password: String, new_name: String, ) -> Result<()>

Update a Profile’s username by its id and password

async fn delete_profile(&self, id: String) -> Result<()>

Delete a profile

VALIDATION SHOULD BE DONE BEFORE THIS!!

pub async fn delete_profile_by_id(&self, id: String) -> Result<()>

Delete an existing Profile by its id

pub async fn get_group_by_id(&self, id: i32) -> Result<Group>

Get a group by its id

Arguments:

• username - String of the user’s username

pub async fn get_follow( &self, user: String, following: String, ) -> Result<UserFollow>

Get an existing UserFollow

Arguments:

• user
• following

pub async fn get_followers( &self, user: String, ) -> Result<Vec<(UserFollow, Box<Profile>, Box<Profile>)>>

Get all existing UserFollows where following is the value of user

Arguments:

• user

pub async fn get_followers_paginated( &self, user: String, page: i32, ) -> Result<Vec<(UserFollow, Box<Profile>, Box<Profile>)>>

Get all existing UserFollows where following is the value of user, 50 at a time

Arguments:

• user
• page

pub async fn get_followers_count(&self, user: String) -> usize

Get the number of followers user has

Arguments:

• user

pub async fn get_following( &self, user: String, ) -> Result<Vec<(UserFollow, Box<Profile>, Box<Profile>)>>

Get all existing UserFollows where user is the value of user

Arguments:

• user

pub async fn get_following_paginated( &self, user: String, page: i32, ) -> Result<Vec<(UserFollow, Box<Profile>, Box<Profile>)>>

Get all existing UserFollows where user is the value of user, 50 at a time

Arguments:

• user
• page

pub async fn get_following_count(&self, user: String) -> usize

Get the number of users user is following

Arguments:

• user

pub async fn toggle_user_follow(&self, props: &mut UserFollow) -> Result<()>

Toggle the following status of user on following (UserFollow)

Arguments:

• props - UserFollow

pub async fn force_remove_user_follow( &self, props: &mut UserFollow, ) -> Result<()>

Force remove the following status of user on following (UserFollow)

Arguments:

• props - UserFollow

pub async fn get_notification(&self, id: String) -> Result<Notification>

Get an existing notification

Arguments:

• id

pub async fn get_notifications_by_recipient( &self, recipient: String, ) -> Result<Vec<Notification>>

Get all notifications by their recipient

Arguments:

• recipient

pub async fn get_notification_count_by_recipient( &self, recipient: String, ) -> usize

Get the number of notifications by their recipient

Arguments:

• recipient

pub async fn get_notifications_by_recipient_paginated( &self, recipient: String, page: i32, ) -> Result<Vec<Notification>>

Get all notifications by their recipient, 50 at a time

Arguments:

• recipient
• page

pub async fn create_notification( &self, props: NotificationCreate, id: Option<String>, ) -> Result<()>

Create a new notification

Arguments:

• props - NotificationCreate

pub async fn delete_notification( &self, id: String, user: Box<Profile>, ) -> Result<()>

Delete an existing notification

Notifications can only be deleted by their recipient.

Arguments:

• id - the ID of the notification
• user - the user doing this

pub async fn delete_notifications_by_recipient( &self, recipient: String, user: Box<Profile>, ) -> Result<()>

Delete all existing notifications by their recipient

Arguments:

• id - the ID of the notification
• user - the user doing this

pub async fn get_warning(&self, id: String) -> Result<Warning>

Get an existing warning

Arguments:

• id

pub async fn get_warnings_by_recipient( &self, recipient: String, user: Box<Profile>, ) -> Result<Vec<Warning>>

Get all warnings by their recipient

Arguments:

• recipient
• user - the user doing this

pub async fn create_warning( &self, props: WarningCreate, user: Box<Profile>, ) -> Result<()>

Create a new warning

Arguments:

• props - WarningCreate
• user - the user creating this warning

pub async fn delete_warning(&self, id: String, user: Box<Profile>) -> Result<()>

Delete an existing warning

Warnings can only be deleted by their moderator or admins.

Arguments:

• id - the ID of the warning
• user - the user doing this

pub async fn get_ipban(&self, id: String) -> Result<IpBan>

Get an existing IpBan

Arguments:

• id

pub async fn get_ipban_by_ip(&self, ip: String) -> Result<IpBan>

Get an existing IpBan by its IP

Arguments:

• ip

pub async fn get_ipbans(&self, user: Box<Profile>) -> Result<Vec<IpBan>>

Get all IpBans

Arguments:

• user - the user doing this

pub async fn create_ipban( &self, props: IpBanCreate, user: Box<Profile>, ) -> Result<()>

Create a new IpBan

Arguments:

• props - IpBanCreate
• user - the user creating this ban

pub async fn delete_ipban(&self, id: String, user: Box<Profile>) -> Result<()>

Delete an existing IpBan

Arguments:

• id - the ID of the ban
• user - the user doing this

pub async fn get_user_relationship( &self, user: String, other: String, ) -> (RelationshipStatus, String, String)

Get the membership status of the given user and the other user

Arguments

• user - the ID of the first user
• other - the ID of the second user

pub async fn set_user_relationship_status( &self, one: String, two: String, status: RelationshipStatus, disable_notifications: bool, ) -> Result<()>

Set the relationship of user one and two

Arguments

• one - the ID of the first user
• two - the ID of the second user
• status - the new relationship status, setting to “Unknown” will remove the relationship
• disable_notifications

pub async fn get_user_relationships( &self, user: String, ) -> Result<Vec<(Box<Profile>, RelationshipStatus)>>

Get all relationships owned by user (ownership is the relationship’s one field)

Arguments

• user

pub async fn get_user_relationships_of_status( &self, user: String, status: RelationshipStatus, ) -> Result<Vec<(Box<Profile>, RelationshipStatus)>>

Get all relationships owned by user (ownership is the relationship’s one field)

Arguments

• user
• status

pub async fn get_user_participating_relationships_of_status( &self, user: String, status: RelationshipStatus, ) -> Result<Vec<(Box<Profile>, Box<Profile>)>>

Get all relationships where user is either one or two and the status is status

Arguments

• user
• status

pub async fn get_user_participating_relationships_of_status_paginated( &self, user: String, status: RelationshipStatus, page: i32, ) -> Result<Vec<(Box<Profile>, Box<Profile>)>>

Get all relationships where user is either one or two and the status is status, 50 at a time

Arguments

• user
• status
• page

pub async fn get_friendship_count_by_user(&self, id: String) -> usize

Get the number of friends a user has

Arguments

• id

pub async fn get_ipblock(&self, id: String) -> Result<IpBlock>

Get an existing IpBlock

Arguments:

• id

pub async fn get_ipblock_by_ip( &self, ip: String, user: String, ) -> Result<IpBlock>

Get an existing IpBlock by its IP and its user

Arguments:

• ip
• user

pub async fn get_ipblocks(&self, query_user: String) -> Result<Vec<IpBlock>>

Get all [IpBlocks]s for the given query_user

Arguments:

• query_user - the ID of the user the blocks belong to

pub async fn create_ipblock( &self, props: IpBlockCreate, user: Box<Profile>, ) -> Result<()>

Create a new IpBlock

Arguments:

• props - IpBlockCreate
• user - the user creating this block

pub async fn delete_ipblock(&self, id: String, user: Box<Profile>) -> Result<()>

Delete an existing IpBlock

Arguments:

• id - the ID of the block
• user - the user doing this

pub async fn get_mail(&self, id: String) -> Result<Mail>

Get an existing mail

Arguments:

• id

pub async fn get_mail_by_recipient_paginated( &self, recipient: String, page: i32, ) -> Result<Vec<(Mail, Box<Profile>)>>

Get all mail by their recipient, 50 at a time

Arguments:

• recipient
• page

pub async fn get_mail_by_recipient_sent_paginated( &self, recipient: String, page: i32, ) -> Result<Vec<(Mail, Box<Profile>)>>

Get all mail by their recipient, 50 at a time

Arguments:

• recipient
• page

pub async fn create_mail( &self, props: MailCreate, author: String, ) -> Result<Mail>

Create a new mail

Arguments:

• props - MailCreate

pub async fn delete_mail(&self, id: String, user: Box<Profile>) -> Result<()>

Delete an existing mail

Mail can only be deleted by their recipient.

Arguments:

• id - the ID of the mail
• user - the user doing this

pub async fn update_mail_state( &self, id: String, state: MailState, user: Box<Profile>, ) -> Result<()>

Update mail state

Arguments:

• id
• state - MailState
• user

pub async fn gimme_label( &self, res: HashMap<String, String>, ) -> Result<UserLabel>

Get a UserLabel from a database result

pub async fn get_label(&self, id: String) -> Result<UserLabel>

Get an existing label

Arguments:

• id

pub async fn create_label( &self, name: String, author: String, ) -> Result<UserLabel>

Create a new user label

Arguments

• name - the name of the label
• author - the ID of the user creating the label

Trait Implementations

impl Clone for Database

fn clone(&self) -> Database

Returns a copy of the value.

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

Performs copy-assignment from source.