Struct discord_flows::model::Role

pub struct Role {
    pub id: RoleId,
    pub guild_id: GuildId,
    pub colour: u32,
    pub hoist: bool,
    pub managed: bool,
    pub mentionable: bool,
    pub name: String,
    pub permissions: Permissions,
    pub position: i64,
    pub tags: RoleTags,
    pub icon: Option<String>,
    pub unicode_emoji: Option<String>,
}

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.

Discord docs.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: RoleId

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

guild_id: GuildId

The Id of the Guild the Role is in.

colour: u32

The colour of the role.

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 Self::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.

tags: RoleTags

The tags this role has. It can be used to determine if this role is a special role in this guild such as guild subscriber role, or if the role is linked to an Integration or a bot.

icon: Option<String>

Role icon image hash.

role-icons/<role_id>/<hash>.png - PNG, JPEG, WEBP role-icons/<role_id>/a_<hash>.gif - GIF, Animated WEBP

unicode_emoji: Option<String>

Role unicoded image.

Trait Implementations

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<(), Error>

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl Display for Role

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

Format a mention for the role, pinging its members.

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

fn from(role: &Role) -> RoleId

Gets the Id of a role.

impl From<InterimRole> for Role

fn from(r: InterimRole) -> Role

Converts to this type from the input type.

impl From<Role> for RoleId

fn from(role: Role) -> RoleId

Gets the Id of a role.

impl Mentionable for Role

fn mention(&self) -> Mention

Creates a Mention that will be able to notify or create a link to the item.

impl Ord for Role

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

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 ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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 Serialize for Role

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

Serialize this value into the given Serde serializer.

impl Eq for Role