Struct serenity::model::user::CurrentUser

#[non_exhaustive]
pub struct CurrentUser {
    pub id: UserId,
    pub avatar: Option<String>,
    pub bot: bool,
    pub discriminator: u16,
    pub email: Option<String>,
    pub mfa_enabled: bool,
    pub name: String,
    pub verified: Option<bool>,
    pub public_flags: Option<UserPublicFlags>,
    pub banner: Option<String>,
    pub accent_colour: Option<Colour>,
}

Information about the current user.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: UserId

avatar: Option<String>

bot: bool

discriminator: u16

email: Option<String>

mfa_enabled: bool

name: String

verified: Option<bool>

public_flags: Option<UserPublicFlags>

banner: Option<String>

accent_colour: Option<Colour>

Implementations

impl CurrentUser

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

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.

Examples

Print out the current user’s avatar url if one is set:

// assuming the cache has been unlocked
let user = cache.current_user().await;

match user.avatar_url() {
    Some(url) => println!("{}'s avatar can be found at {}", user.name, url),
    None => println!("{} does not have an avatar set.", user.name),
}

pub fn default_avatar_url(&self) -> String

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

This will produce a PNG URL.

pub async fn edit<F>(&mut self, http: impl AsRef<Http>, f: F) -> Result<()> where
    F: FnOnce(&mut EditProfile) -> &mut EditProfile, 

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 = serenity::utils::read_image("./avatar.png")?;

user.edit(&http, |p| p.avatar(Some(&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.

pub fn face(&self) -> String

Retrieves the URL to the current 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.

pub async fn guilds(&self, http: impl AsRef<Http>) -> Result<Vec<GuildInfo>>

Gets a list of guilds that the current user is in.

Examples

Print out the names of all guilds the current user is in:

// assuming the user has been bound

if let Ok(guilds) = user.guilds(&http).await {
    for (index, guild) in guilds.into_iter().enumerate() {
        println!("{}: {}", index, guild.name);
    }
}

Errors

May return an Error::Http if the Discord API returns an error. Also can return Error::Json if there is an error in deserializing the data returned by the API.

pub async fn invite_url(
    &self,
    http: impl AsRef<Http>,
    permissions: Permissions
) -> Result<String>

Returns the invite url for the bot with the given permissions.

This queries the REST API for the client id.

If the permissions passed are empty, the permissions part will be dropped.

Only the bot scope is used, if you wish to use more, such as slash commands, see Self::invite_url_with_oauth2_scopes

Examples

Get the invite url with no permissions set:

use serenity::model::Permissions;

// assuming the user has been bound
let url = match user.invite_url(&http, Permissions::empty()).await {
    Ok(v) => v,
    Err(why) => {
        println!("Error getting invite url: {:?}", why);

        return;
    },
};

assert_eq!(
    url,
    "https://discordapp.com/api/oauth2/authorize? \
                 client_id=249608697955745802&scope=bot"
);

Get the invite url with some basic permissions set:

use serenity::model::Permissions;

// assuming the user has been bound
let permissions =
    Permissions::READ_MESSAGES | Permissions::SEND_MESSAGES | Permissions::EMBED_LINKS;
let url = match user.invite_url(&http, permissions).await {
    Ok(v) => v,
    Err(why) => {
        println!("Error getting invite url: {:?}", why);

        return;
    },
};

assert_eq!(
    url,
    "https://discordapp.
com/api/oauth2/authorize?client_id=249608697955745802&scope=bot&permissions=19456"
);

Errors

Returns an HttpError::UnsuccessfulRequest(Unauthorized) If the user is not authorized for this end point.

Should never return Error::Url as all the data is controlled over.

pub async fn invite_url_with_oauth2_scopes(
    &self,
    http: impl AsRef<Http>,
    permissions: Permissions,
    scopes: &[OAuth2Scope]
) -> Result<String>

Generate an invite url, but with custom scopes.

Examples

Get the invite url with no permissions set and slash commands support:

use serenity::model::oauth2::OAuth2Scope;
use serenity::model::Permissions;

let scopes = vec![OAuth2Scope::Bot, OAuth2Scope::ApplicationsCommands];

// assuming the user has been bound
let url = match user.invite_url_with_oauth2_scopes(&http, Permissions::empty(), &scopes).await {
    Ok(v) => v,
    Err(why) => {
        println!("Error getting invite url: {:?}", why);

        return;
    },
};

assert_eq!(
    url,
    "https://discordapp.com/api/oauth2/authorize? \
                 client_id=249608697955745802&scope=bot%20applications.commands"
);

Errors

Returns an HttpError::UnsuccessfulRequest(Unauthorized) If the user is not authorized for this end point.

Should never return Error::Url as all the data is controlled over.

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

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

This will always produce a WEBP image URL.

Examples

Print out the current user’s static avatar url if one is set:

// assuming the user has been bound

match user.static_avatar_url() {
    Some(url) => println!("{}'s static avatar can be found at {}", user.name, url),
    None => println!("Could not get static avatar for {}.", user.name),
}

pub fn tag(&self) -> String

Returns the tag of the current user.

Examples

Print out the current user’s distinct identifier (e.g., Username#1234):

// assuming the user has been bound

println!("The current user's distinct identifier is {}", user.tag());

Trait Implementations

impl Clone for CurrentUser

fn clone(&self) -> CurrentUser

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CurrentUser

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CurrentUser

fn default() -> CurrentUser

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CurrentUser

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<&'_ CurrentUser> for Mention

fn from(value: &CurrentUser) -> Self

Performs the conversion.

impl<'a> From<&'a CurrentUser> for User

fn from(user: &'a CurrentUser) -> Self

Performs the conversion.

impl<'a> From<&'a CurrentUser> for UserId

fn from(current_user: &CurrentUser) -> UserId

Gets the Id of a CurrentUser struct.

impl From<CurrentUser> for User

fn from(user: CurrentUser) -> Self

Performs the conversion.

impl From<CurrentUser> for UserId

fn from(current_user: CurrentUser) -> UserId

Gets the Id of a CurrentUser struct.

impl Mentionable for CurrentUser

fn mention(&self) -> Mention

Creates a Mention that will be able to notify or create a link to the item.

impl Serialize for CurrentUser

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.