Struct serenity::builder::EditProfile

pub struct EditProfile(pub HashMap<&'static str, Value>);

A builder to edit the current user's settings, to be used in conjunction with CurrentUser::edit.

Methods

impl EditProfile

pub fn avatar(&mut self, avatar: Option<&str>) -> &mut Self

Sets the avatar of the current user. None can be passed to remove an avatar.

A base64-encoded string is accepted as the avatar content.

Examples

A utility method - utils::read_image - is provided to read an image from a file and return its contents in base64-encoded form:

        use serenity::utils;

        // assuming a `context` has been bound

        let base64 = utils::read_image("./my_image.jpg")
        .expect("Failed to read image");

        let _ = context.cache.write().user.edit(&context, |p|
            p.avatar(Some(&base64)));

pub fn email(&mut self, email: &str) -> &mut Self

Modifies the current user's email address.

Note that when modifying the email address, the current password must also be provided.

No validation is performed on this by the library.

Note: This can only be used by user accounts.

pub fn new_password(&mut self, new_password: &str) -> &mut Self

Modifies the current user's password.

Note that when modifying the password, the current password must also be provided.

pub fn password(&mut self, password: &str) -> &mut Self

Used for providing the current password as verification when modifying the password or modifying the associated email address.

pub fn username<S: ToString>(&mut self, username: S) -> &mut Self

Modifies the current user's username.

When modifying the username, if another user has the same new username and current discriminator, a new unique discriminator will be assigned. If there are no available discriminators with the requested username, an error will occur.

Trait Implementations

impl Clone for EditProfile

fn clone(&self) -> EditProfile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EditProfile

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

Formats the value using the given formatter.

impl Default for EditProfile

fn default() -> EditProfile

Returns the "default value" for a type.