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
Expand description
The Id of the role. Can be used to calculate the role’s creation date.
guild_id: GuildId
Expand description
The Id of the Guild the Role is in.
colour: Colour
Expand description
The colour of the role. This is an ergonomic representation of the inner value.
hoist: bool
Expand description
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
Expand description
Indicator of whether the role is managed by an integration service.
mentionable: bool
Expand description
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
Expand description
The name of the role.
permissions: Permissions
Expand description
A set of permissions that the role has been assigned.
See the permissions
module for more information.
position: i64
Expand description
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
.
Expand description
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
impl Role
[src]
impl Role
[src]pub async fn delete(&mut self, http: impl AsRef<Http>) -> Result<()>
[src]
pub async fn delete(&mut self, http: impl AsRef<Http>) -> Result<()>
[src]Deletes the role.
Note Requires the Manage Roles permission.
Errors
Returns Error::Http
if the curent user lacks permission to
delete this role.
pub async fn edit(
&self,
http: impl AsRef<Http>,
f: impl FnOnce(&mut EditRole) -> &mut EditRole
) -> Result<Role>
[src]
pub async fn edit(
&self,
http: impl AsRef<Http>,
f: impl FnOnce(&mut EditRole) -> &mut EditRole
) -> Result<Role>
[src]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.
pub fn has_permission(&self, permission: Permissions) -> bool
[src]
pub fn has_permission(&self, permission: Permissions) -> bool
[src]Check that the role has the given permission.
pub fn has_permissions(&self, permissions: Permissions, precise: bool) -> bool
[src]
pub fn has_permissions(&self, permissions: Permissions, precise: bool) -> bool
[src]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<'de> Deserialize<'de> for Role
[src]
impl<'de> Deserialize<'de> for Role
[src]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
impl FromStrAndCache for Role
[src]
impl FromStrAndCache for Role
[src]impl Mentionable for Role
[src]
impl Mentionable for Role
[src]impl Ord for Role
[src]
impl Ord for Role
[src]impl PartialOrd<Role> for Role
[src]
impl PartialOrd<Role> for Role
[src]fn partial_cmp(&self, other: &Role) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &Role) -> Option<Ordering>
[src]This method returns an ordering between self
and other
values if one exists. Read more
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than (for self
and other
) and is used by the <
operator. Read more
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl Eq for Role
[src]
Auto Trait Implementations
impl RefUnwindSafe for Role
impl Send for Role
impl Sync for Role
impl Unpin for Role
impl UnwindSafe for Role
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]pub fn equivalent(&self, key: &K) -> bool
[src]
pub fn equivalent(&self, key: &K) -> bool
[src]Compare self to key
and return true
if they are equal.
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
fn in_current_span(self) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,