Struct twilight_http::request::guild::role::CreateRole

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

Create a role in a guild.

Examples

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

let client = Client::new("my token".to_owned());
let guild_id = Id::new(234);

client
    .create_role(guild_id)
    .color(0xd90083)
    .name("Bright Pink")
    .await?;

Implementations

impl<'a> CreateRole<'a>

pub const fn color(self, color: 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: &'a [u8]) -> Self

Set the icon of the role.

Only works if the guild has the ROLE_ICONS feature.

See Discord Docs/Image Data.

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

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

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

Set the name of the role.

If none is specified, Discord sets this to New Role.

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

Set the allowed permissions of this role.

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

Set the unicode emoji of a role.

pub fn exec(self) -> ResponseFuture<Role>

👎Deprecated since 0.14.0: use .await or into_future instead

Execute the request, returning a future resolving to a Response.

Trait Implementations

impl<'a> AuditLogReason<'a> for CreateRole<'a>

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

Attach an audit log reason to the request.

impl IntoFuture for CreateRole<'_>

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 CreateRole<'_>

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

Try to convert a request builder into a raw Request.