Struct serenity::model::guild::Role

pub struct Role {
    pub id: RoleId,
    pub colour: Colour,
    pub hoist: bool,
    pub managed: bool,
    pub mentionable: bool,
    pub name: String,
    pub permissions: Permissions,
    pub position: i64,
    // some fields omitted
}

Information about a role within a guild. A role represents a set of permissions, and can be attached to one or multiple users. A role has various miscellaneous configurations, such as being assigned a colour. Roles are unique per guild and do not cross over to other guilds in any way, and can have channel-specific permission overrides in addition to guild-level permissions.

Fields

id: RoleId

The Id of the role. Can be used to calculate the role's creation date.

colour: Colour

The colour of the role. This is an ergonomic representation of the inner value.

hoist: bool

Indicator of whether the role is pinned above lesser roles.

In the client, this causes Members in the role to be seen above those in roles with a lower position.

managed: bool

Indicator of whether the role is managed by an integration service.

mentionable: bool

Indicator of whether the role can be mentioned, similar to mentioning a specific member or @everyone.

Only members of the role will be notified if a role is mentioned with this set to true.

name: String

The name of the role.

permissions: Permissions

A set of permissions that the role has been assigned.

See the permissions module for more information.

position: i64

The role's position in the position list. Roles are considered higher in hierarchy if their position is higher.

The @everyone role is usually either -1 or 0.

Methods

impl Role

pub fn delete<T>(&mut self, cache_and_http: T) -> Result<()> where
    T: AsRef<CacheRwLock> + AsRef<Http>, 

Deletes the role.

Note Requires the Manage Roles permission.

pub fn edit<F: FnOnce(&mut EditRole) -> &mut EditRole, T>(
    &self,
    cache_and_http: T,
    f: F
) -> Result<Role> where
    T: AsRef<CacheRwLock> + AsRef<Http>, 

Edits a Role, optionally setting its new fields.

Requires the Manage Roles permission.

Examples

Make a role hoisted:

// assuming a `role` has already been bound
role.edit(|mut r| {
    r.hoist(true);

    r
});

pub fn find_guild(&self, cache: impl AsRef<CacheRwLock>) -> Result<GuildId>

Searches the cache for the guild that owns the role.

Errors

Returns a ModelError::GuildNotFound if a guild is not in the cache that contains the role.

pub fn has_permission(&self, permission: Permissions) -> bool

Check that the role has the given permission.

pub fn has_permissions(&self, permissions: Permissions, precise: bool) -> bool

Checks whether the role has all of the given permissions.

The 'precise' argument is used to check if the role's permissions are precisely equivalent to the given permissions. If you need only check that the role has at least the given permissions, pass false.

Trait Implementations

impl Mentionable for Role

fn mention(&self) -> String

Creates a mentionable string, that will be able to notify and/or create a link to the item.

impl FromStrAndCache for Role

type Err = RoleParseError

fn from_str(
    cache: impl AsRef<CacheRwLock>,
    s: &str
) -> StdResult<Self, Self::Err>

impl PartialOrd<Role> for Role

fn partial_cmp(&self, other: &Role) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<Role> for Role

fn eq(&self, other: &Role) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Ord for Role

fn cmp(&self, other: &Role) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Eq for Role

impl From<Role> for RoleId

fn from(role: Role) -> RoleId

Gets the Id of a role.

impl<'a> From<&'a Role> for RoleId

fn from(role: &Role) -> RoleId

Gets the Id of a role.

impl Clone for Role

fn clone(&self) -> Role

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Role

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

Formats the value using the given formatter.

impl Display for Role

fn fmt(&self, f: &mut Formatter) -> FmtResult

Format a mention for the role, pinging its members.

impl Serialize for Role

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Role

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.