Struct EditRole

pub struct EditRole<'a> { /* private fields */ }

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

These are:

• PartialGuild::create_role
• PartialGuild::edit_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 `guild_id` has been bound
let builder = EditRole::new().name("a test role").hoist(true).mentionable(true);
let role = guild_id.create_role(&http, builder).await?;

Discord docs

Implementations

impl<'a> EditRole<'a>

pub fn new() -> Self

Equivalent to Self::default.

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

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

pub fn colour(self, colour: impl Into<Colour>) -> Self

Set the colour of the role.

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

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

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

Whether or not to make the role mentionable, upon which users with that role will be notified.

pub fn name(self, name: impl Into<String>) -> Self

Set the role’s name.

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

Set the role’s permissions.

pub fn position(self, position: u16) -> Self

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

pub fn unicode_emoji(self, unicode_emoji: Option<String>) -> Self

Set the role icon to a unicode emoji.

pub fn icon(self, icon: Option<&CreateAttachment>) -> Self

Set the role icon to a custom image.

pub fn audit_log_reason(self, reason: &'a str) -> Self

Sets the request’s audit log reason.

Trait Implementations

impl Builder for EditRole<'_>

fn execute<'life0, 'async_trait>( self, cache_http: impl 'async_trait + CacheHttp, ctx: Self::Context<'life0>, ) -> Pin<Box<dyn Future<Output = Result<Self::Built>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Edits the role.

Note: Requires the Manage Roles permission.

Errors

If the cache is enabled, returns a ModelError::InvalidPermissions if the current user lacks permission. Otherwise returns Error::Http, as well as if invalid data is given.

type Context<'ctx> = (GuildId, Option<RoleId>)

Additional data that’s only required when sending a request off to the API.

type Built = Role

impl<'a> Clone for EditRole<'a>

fn clone(&self) -> EditRole<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for EditRole<'a>

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

Formats the value using the given formatter.

impl<'a> Default for EditRole<'a>

fn default() -> EditRole<'a>

Returns the “default value” for a type.

impl<'a> Serialize for EditRole<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.