[−][src]Struct serenity::model::user::CurrentUser
Information about the current user.
Fields
id: UserId
avatar: Option<String>
bot: bool
discriminator: u16
email: Option<String>
mfa_enabled: bool
name: String
verified: bool
Methods
impl CurrentUser
[src]
pub fn avatar_url(&self) -> Option<String>
[src]
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.user; 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
[src]
Returns the formatted URL to the user's default avatar URL.
This will produce a PNG URL.
pub fn edit<F>(&mut self, http: impl AsRef<Http>, f: F) -> Result<()> where
F: FnOnce(&mut EditProfile) -> &mut EditProfile,
[src]
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").unwrap(); context.cache.write().user.edit(|p| p.avatar(Some(&avatar)));
pub fn face(&self) -> String
[src]
Retrieves the URL to the current user's avatar, falling back to the default avatar if needed.
This will call avatar_url
first, and if that returns None
, it
then falls back to default_avatar_url
.
pub fn guilds(&self, http: impl AsRef<Http>) -> Result<Vec<GuildInfo>>
[src]
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 cache has been unlocked let user = &cache.user; if let Ok(guilds) = user.guilds(&http) { for (index, guild) in guilds.into_iter().enumerate() { println!("{}: {}", index, guild.name); } }
pub fn invite_url(
&self,
http: impl AsRef<Http>,
permissions: Permissions
) -> Result<String>
[src]
&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.
Examples
Get the invite url with no permissions set:
use serenity::model::Permissions; // assuming the cache has been unlocked let url = match cache.user.invite_url(&http, Permissions::empty()) { 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 cache has been unlocked let url = match cache.user.invite_url(&http, Permissions::READ_MESSAGES | Permissions::SEND_MESSAGES | Permissions::EMBED_LINKS) { 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.
May return Error::Format
while writing url to the buffer.
pub fn static_avatar_url(&self) -> Option<String>
[src]
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 cache has been unlocked let user = &cache.user; 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
[src]
Returns the tag of the current user.
Examples
Print out the current user's distinct identifier (e.g., Username#1234):
// assuming the cache has been unlocked println!("The current user's distinct identifier is {}", cache.user.tag());
Trait Implementations
impl Mentionable for CurrentUser
[src]
impl Default for CurrentUser
[src]
fn default() -> CurrentUser
[src]
impl From<CurrentUser> for User
[src]
fn from(user: CurrentUser) -> Self
[src]
impl<'a> From<&'a CurrentUser> for User
[src]
fn from(user: &'a CurrentUser) -> Self
[src]
impl From<CurrentUser> for UserId
[src]
fn from(current_user: CurrentUser) -> UserId
[src]
Gets the Id of a CurrentUser
struct.
impl<'a> From<&'a CurrentUser> for UserId
[src]
fn from(current_user: &CurrentUser) -> UserId
[src]
Gets the Id of a CurrentUser
struct.
impl Clone for CurrentUser
[src]
fn clone(&self) -> CurrentUser
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Debug for CurrentUser
[src]
impl Serialize for CurrentUser
[src]
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl<'de> Deserialize<'de> for CurrentUser
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
Auto Trait Implementations
impl Send for CurrentUser
impl Unpin for CurrentUser
impl Sync for CurrentUser
impl UnwindSafe for CurrentUser
impl RefUnwindSafe for CurrentUser
Blanket Implementations
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> Erased for T
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
U: TryFrom<T>,
impl<T> DebugAny for T where
T: Any + Debug,
[src]
T: Any + Debug,
impl<T> CloneAny for T where
T: Clone + Any,
[src]
T: Clone + Any,
fn clone_any(&self) -> Box<dyn CloneAny + 'static>
[src]
fn clone_any_send(&self) -> Box<dyn CloneAny + 'static + Send> where
T: Send,
[src]
T: Send,
fn clone_any_sync(&self) -> Box<dyn CloneAny + 'static + Sync> where
T: Sync,
[src]
T: Sync,
fn clone_any_send_sync(&self) -> Box<dyn CloneAny + 'static + Sync + Send> where
T: Send + Sync,
[src]
T: Send + Sync,
impl<T> UnsafeAny for T where
T: Any,
T: Any,