Struct serenity::model::guild::Role [−][src]
#[non_exhaustive]pub struct Role { pub id: RoleId, pub guild_id: GuildId, pub colour: Colour, pub hoist: bool, pub managed: bool, pub mentionable: bool, pub name: String, pub permissions: Permissions, pub position: i64, pub tags: RoleTags, }
Expand description
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 (Non-exhaustive)
This struct is marked as non-exhaustive
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: 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 Member
s 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
.
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.
Implementations
Deletes the role.
Note Requires the Manage Roles permission.
Errors
Returns Error::Http
if the curent user lacks permission to
delete this role.
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 });
Errors
Returns Error::Http
if the current user does not
have permission to Manage Roles.
Check that the role has the given permission.
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
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Auto Trait Implementations
impl RefUnwindSafe for Role
impl UnwindSafe for Role
Blanket Implementations
Mutably borrows from an owned value. Read more
Compare self to key
and return true
if they are equal.
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
type Output = T
type Output = T
Should always be Self
pub fn vzip(self) -> V