Struct serenity::model::user::CurrentUser

source ·

pub struct CurrentUser(/* private fields */);

Expand description

Information about the current user.

Discord docs.

Implementations§

source §

impl CurrentUser

source

pub async fn edit( &mut self, cache_http: impl CacheHttp, builder: EditProfile ) -> Result<()>

Available on crate feature model only.

Edits the current user’s profile settings.

This mutates the current user in-place.

Refer to EditProfile’s documentation for its methods.

§Examples

Change the avatar:

let avatar = CreateAttachment::path("./avatar.png").await?;
user.edit(&http, EditProfile::new().avatar(&avatar)).await;

§Errors

Returns an Error::Http if an invalid value is set. May also return an Error::Json if there is an error in deserializing the API response.

Methods from Deref<Target = User>§

source

pub fn avatar_url(&self) -> Option<String>

Available on crate feature model only.

Returns the formatted URL of the user’s icon, if one exists.

This will produce a WEBP image URL, or GIF if the user has a GIF avatar.

source

pub fn banner_url(&self) -> Option<String>

Available on crate feature model only.

Returns the formatted URL of the user’s banner, if one exists.

This will produce a WEBP image URL, or GIF if the user has a GIF banner.

Note: This will only be present if the user is fetched via Rest API, e.g. with crate::http::Http::get_user.

source

pub async fn create_dm_channel( &self, cache_http: impl CacheHttp ) -> Result<PrivateChannel>

Available on crate feature model only.

Creates a direct message channel between the current user and the user. This can also retrieve the channel if one already exists.

§Errors

See UserId::create_dm_channel for what errors may be returned.

source

pub fn created_at(&self) -> Timestamp

Available on crate feature model only.

Retrieves the time that this user was created at.

source

pub fn default_avatar_url(&self) -> String

Available on crate feature model only.

Returns the formatted URL to the user’s default avatar URL.

This will produce a PNG URL.

source

pub async fn direct_message( &self, cache_http: impl CacheHttp, builder: CreateMessage ) -> Result<Message>

Available on crate feature model only.

Sends a message to a user through a direct message channel. This is a channel that can only be accessed by you and the recipient.

§Examples

When a user sends a message with a content of "~help", DM the author a help message

use serenity::builder::CreateMessage;

#[serenity::async_trait]
impl EventHandler for Handler {
    async fn message(&self, ctx: Context, msg: Message) {
        if msg.content == "~help" {
            let builder = CreateMessage::new().content("Helpful info here.");

            if let Err(why) = msg.author.direct_message(&ctx, builder).await {
                println!("Err sending help: {why:?}");
                let _ = msg.reply(&ctx, "There was an error DMing you help.").await;
            };
        }
    }
}

§Errors

Returns a ModelError::MessagingBot if the user being direct messaged is a bot user.

May also return an Error::Http if the user cannot be sent a direct message.

Returns an Error::Json if there is an error deserializing the API response.

source

pub async fn dm( &self, cache_http: impl CacheHttp, builder: CreateMessage ) -> Result<Message>

Available on crate feature model only.

This is an alias of Self::direct_message.

source

pub fn face(&self) -> String

Available on crate feature model only.

Retrieves the URL to the user’s avatar, falling back to the default avatar if needed.

This will call Self::avatar_url first, and if that returns None, it then falls back to Self::default_avatar_url.

source

pub fn static_face(&self) -> String

Available on crate feature model only.

Retrieves the URL to the static version of the user’s avatar, falling back to the default avatar if needed.

This will call Self::static_avatar_url first, and if that returns None, it then falls back to Self::default_avatar_url.

source

pub async fn has_role( &self, cache_http: impl CacheHttp, guild_id: impl Into<GuildId>, role: impl Into<RoleId> ) -> Result<bool>

Available on crate feature model only.

Check if a user has a Role. This will retrieve the Guild from the Cache if it is available, and then check if that guild has the given Role.

§Examples

Check if a guild has a Role by Id:

// Assumes a 'guild_id' and `role_id` have already been bound
let _ = message.author.has_role(guild_id, role_id);

§Errors

Returns an Error::Http if the given Guild is unavailable, if that Role does not exist in the given Guild, or if the given User is not in that Guild.

May also return an Error::Json if there is an error in deserializing the API response.

source

pub async fn refresh(&mut self, cache_http: impl CacheHttp) -> Result<()>

Available on crate feature model only.

Refreshes the information about the user.

Replaces the instance with the data retrieved over the REST API.

§Errors

See UserId::to_user for what errors may be returned.

source

pub fn static_avatar_url(&self) -> Option<String>

Available on crate feature model only.

Returns a static formatted URL of the user’s icon, if one exists.

This will always produce a WEBP image URL.

source

pub fn tag(&self) -> String

Available on crate feature model only.

Returns the “tag” for the user.

The “tag” is defined as “username#discriminator”, such as “zeyla#5479”.

§Examples

Make a command to tell the user what their tag is:


#[serenity::async_trait]
impl EventHandler for Handler {
    async fn message(&self, context: Context, msg: Message) {
        if msg.content == "!mytag" {
            let content = format!("Your tag is: {}", msg.author.tag());
            let _ = msg.channel_id.say(&context.http, &content).await;
        }
    }
}