Struct UpdateRole

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

Update a role by guild id and its id.

Implementations

impl<'a> UpdateRole<'a>

pub const fn color(self, color: Option<u32>) -> Self

Set the role color.

This must be a valid hexadecimal RGB value. 0x000000 is ignored and doesn’t count towards the final computed color in the user list. Refer to COLOR_MAXIMUM for the maximum acceptable value.

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

If true, display the role in the members list.

pub const fn icon(self, icon: Option<&'a str>) -> Self

Set the icon of the role.

Only works if the guild has the ROLE_ICONS feature.

See Discord Docs/Image Data.

Editing

Pass None to clear the existing icon.

Warning: If the existing unicode emoji isn’t cleared when setting the icon, it might cause incorrect behavior.

Examples

Sets a role icon. The unicode emoji should always be cleared to ensure the icon can be set correctly.

use twilight_http::Client;
use twilight_model::id::Id;

let client = Client::new("token".to_owned());
let guild_id = Id::new(1);
let role_id = Id::new(1);
let icon = "data:image/png;base64,BASE64_ENCODED_PNG_IMAGE_DATA";

client
    .update_role(guild_id, role_id)
    .icon(Some(icon))
    .unicode_emoji(None)
    .await?;

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

If true, the role can be @mentioned (pinged) in chat.

pub const fn name(self, name: Option<&'a str>) -> Self

Set the name of the role.

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

Set the allowed permissions of this role.

pub const fn unicode_emoji(self, unicode_emoji: Option<&'a str>) -> Self

Set the unicode emoji of a role.

Only works if the guild has the ROLE_ICONS feature.

Editing

Pass None to clear the existing unicode emoji.

Warning: If the existing icon isn’t cleared when setting the unicode emoji, it might cause incorrect behavior.

Examples

Sets a role unicode emoji. The icon should always be cleared to ensure the unicode emoji can be set correctly.

use twilight_http::Client;
use twilight_model::id::Id;

let client = Client::new("token".to_owned());
let guild_id = Id::new(1);
let role_id = Id::new(1);

client
    .update_role(guild_id, role_id)
    .icon(None)
    .unicode_emoji(Some("🦀"))
    .await?;

Trait Implementations

impl<'a> AuditLogReason<'a> for UpdateRole<'a>

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

Attach an audit log reason to the request.

impl IntoFuture for UpdateRole<'_>

type Output = Result<Response<Role>, Error>

The output that the future will produce on completion.

type IntoFuture = ResponseFuture<Role>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.

impl TryIntoRequest for UpdateRole<'_>

fn try_into_request(self) -> Result<Request, Error>

Try to convert a request builder into a raw Request.