Struct serenity::utils::builder::EditRole

pub struct EditRole(pub ObjectBuilder);

A builer to create or edit a Role for use via a number of model and context methods.

These are:

• Context::create_role
• Context::edit_role
• Guild::create_role
• Role::edit

Defaults are provided for each parameter on role creation.

Examples

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

// assuming you are in a `context` and a `guild_id` has been bound
let role = context.create_role(guild_id, |r| r
    .hoist(true)
    .mentionable(true)
    .name("a test role"));

Methods

impl EditRole

fn new(role: &Role) -> Self

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

fn colour(self, colour: u64) -> Self

Sets the colour of the role.

fn hoist(self, hoist: bool) -> Self

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

fn mentionable(self, mentionable: bool) -> Self

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

fn name(self, name: &str) -> Self

The name of the role to set.

fn permissions(self, permissions: Permissions) -> Self

The set of permissions to assign the role.

fn position(self, position: u8) -> Self

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

Trait Implementations

impl Default for EditRole

fn default() -> EditRole

Creates a builder with default parameters.

The defaults are:

• color: 10070709
• hoist: false
• mentionable: false
• name: new role
• permissions: the general permissions set
• position: 1