Struct guppy::db::Database

pub struct Database {
    pub base: StarterDatabase,
    pub auth: AuthDatabase,
    pub logs: LogDatabase,
}

Fields

base: StarterDatabase

auth: AuthDatabase

logs: LogDatabase

Implementations

impl Database

pub async fn new(opts: DatabaseOpts) -> Database

pub async fn init(&self)

pub async fn get_user_by_hashed( &self, hashed: String ) -> DefaultReturn<Option<FullUser<String>>>

Get a user by their hashed ID

Arguments:

• hashed - String of the user’s hashed ID

pub async fn get_user_by_unhashed( &self, unhashed: String ) -> DefaultReturn<Option<FullUser<String>>>

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

Calls Database::get_user_by_unhashed_st() if user is invalid.

Arguments:

• unhashed - String of the user’s unhashed ID

pub async fn get_user_by_unhashed_st( &self, unhashed: String ) -> DefaultReturn<Option<FullUser<String>>>

Get a user by their unhashed secondary token

Arguments:

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

pub async fn get_user_by_username( &self, username: String ) -> DefaultReturn<Option<FullUser<String>>>

Get a user by their username

Arguments:

• username - String of the user’s username

pub async fn get_level_by_role( &self, name: String ) -> DefaultReturn<RoleLevelLog>

Get a RoleLevel by its name

Arguments:

• name - String of the level’s role name

pub async fn create_user( &self, username: String ) -> DefaultReturn<Option<String>>

Create a new user given their username. Returns their hashed ID

Arguments:

• username - String of the user’s username

pub async fn edit_user_metadata_by_name( &self, name: String, metadata: UserMetadata ) -> DefaultReturn<Option<String>>

Update a UserState’s metadata by its username

pub async fn ban_user_by_name( &self, name: String ) -> DefaultReturn<Option<String>>

Ban a UserState by its username

pub async fn get_follow_by_user( &self, user: String, is_following: String ) -> DefaultReturn<Option<Log>>

Get a UserFollow by the username of the user following

Arguments:

• user - username of user following
• is_following - the username of the user that user is following

pub async fn get_user_followers( &self, user: String, offset: Option<i32> ) -> DefaultReturn<Option<Vec<Log>>>

Get the UserFollows that are following the given user

Arguments:

• user - username of user to check
• offset - optional value representing the SQL fetch offset

pub async fn get_user_following( &self, user: String, offset: Option<i32> ) -> DefaultReturn<Option<Vec<Log>>>

Get the UserFollows that the given user is following

Arguments:

• user - username of user to check
• offset - optional value representing the SQL fetch offset

pub async fn get_user_follow_count(&self, user: String) -> DefaultReturn<usize>

Get the amount of followers a user has

Arguments:

• user - username of user to check

pub async fn get_user_following_count( &self, user: String ) -> DefaultReturn<usize>

Get the amount of users a user is following

Arguments:

• user - username of user to check

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

Toggle the following status of user on is_following (UserFollow)

Arguments:

• props - UserFollow

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.