Struct serenity::builder::EditRole

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

A builder to create or edit a Role for use via a number of model methods.

These are:

• PartialGuild::create_role
• Guild::create_role
• Guild::edit_role
• GuildId::create_role
• GuildId::edit_role
• Role::edit

Defaults are provided for each parameter on role creation.

Examples

Create a hoisted, mentionable role named "a test role":

// assuming a `channel_id` and `guild_id` has been bound

let role = guild_id.create_role(&http, |r| r.hoist(true).mentionable(true).name("a test role"));

Tuple Fields

0: HashMap<&'static str, Value>

Implementations

impl EditRole

pub fn new(role: &Role) -> Self

Creates a new builder with the values of the given Role.

pub fn colour(&mut self, colour: u64) -> &mut Self

Sets the colour of the role.

pub fn hoist(&mut self, hoist: bool) -> &mut Self

Whether or not to hoist the role above lower-positioned role in the user list.

pub fn mentionable(&mut self, mentionable: bool) -> &mut Self

Whether or not to make the role mentionable, notifying its users.

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

The name of the role to set.

pub fn permissions(&mut self, permissions: Permissions) -> &mut Self

The set of permissions to assign the role.

pub fn position(&mut self, position: u8) -> &mut Self

The position to assign the role in the role list. This correlates to the role’s position in the user list.

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

The unicode emoji to set as the role image.

pub async fn icon<'a>(
    &mut self,
    http: impl AsRef<Http>,
    icon: impl Into<AttachmentType<'a>>
) -> Result<&mut Self>

The image to set as the role icon.

Errors

May error if the icon is a URL and the HTTP request fails, or if the icon is a file on a path that doesn’t exist.

Trait Implementations

impl Clone for EditRole

fn clone(&self) -> EditRole

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EditRole

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

Formats the value using the given formatter.

impl Default for EditRole

fn default() -> EditRole

Returns the “default value” for a type.