stat_summoner::module::suggestions::utils

Function add_user_to_blacklist

Source 
pub async fn add_user_to_blacklist(
    collection: &Collection<User>,
    user_id: &str,
) -> Result<()>
Expand description

⚙️ Adds a user to the blacklist.

This asynchronous function inserts a new document into a MongoDB collection to blacklist a user. The document includes the user_id, username, and a timestamp indicating when the user was added to the blacklist.

§Parameters:

  • collection: A reference to a MongoDB collection of BlackList documents.
  • user_id: A string slice representing the ID of the user to blacklist.
  • username: A string slice representing the username of the user to blacklist.

§Returns:

  • Result<(), mongodb::error::Error>: Returns Ok(()) if the user is successfully blacklisted. On failure, returns an Error from MongoDB detailing the issue.

§Example:

add_user_to_blacklist(&collection, "123456789012345678", "JohnDoe").await?;
println!("User has been blacklisted.");

§⚠️ Notes:

  • The function creates a new BlackList entry with the provided user_id and username.
  • The created_at field is set to the current timestamp in seconds since the UNIX epoch.
  • BlackList: Represents the structure of a blacklisted user in the database.

§Dependencies:

  • Requires a MongoDB collection containing BlackList documents.
  • Uses the chrono crate to generate a timestamp for the created_at field.