Struct twilight_model::guild::Role

pub struct Role {
    pub color: u32,
    pub hoist: bool,
    pub icon: Option<ImageHash>,
    pub id: Id<RoleMarker>,
    pub managed: bool,
    pub mentionable: bool,
    pub name: String,
    pub permissions: Permissions,
    pub position: i64,
    pub tags: Option<RoleTags>,
    pub unicode_emoji: Option<String>,
}

Fields

color: u32

hoist: bool

icon: Option<ImageHash>

Icon image hash.

Present if the guild has the ROLE_ICONS feature and if the role has one.

See Discord Docs/Image Formatting.

id: Id<RoleMarker>

managed: bool

mentionable: bool

name: String

permissions: Permissions

position: i64

tags: Option<RoleTags>

Tags about the role.

unicode_emoji: Option<String>

Icon unicode emoji.

Present if the guild has the ROLE_ICONS feature and if the role has one.

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

Formats the value using the given formatter.

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.

impl Hash for Role

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Role

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

Compare two roles to each other using their position and ID.

Roles are primarily ordered by their position in descending order. For example, a role with a position of 17 is considered a higher role than one with a position of 12.

Discord does not guarantee that role positions are positive, unique, or contiguous. When two or more roles have the same position then the order is based on the roles’ IDs in ascending order. For example, given two roles with positions of 10 then a role with an ID of 1 would be considered a higher role than one with an ID of 20.

Examples

Compare the position of two roles:

let role_a = Role {
    id: Id::new(123),
    position: 12,
    // ...
};
let role_b = Role {
    id: Id::new(456),
    position: 13,
    // ...
};
assert_eq!(Ordering::Less, role_a.cmp(&role_b));
assert_eq!(Ordering::Greater, role_b.cmp(&role_a));
assert_eq!(Ordering::Equal, role_a.cmp(&role_a));
assert_eq!(Ordering::Equal, role_b.cmp(&role_b));

Compare the position of two roles with the same position:

let role_a = Role {
    id: Id::new(123),
    position: 12,
};
let role_b = Role {
    id: Id::new(456),
    position: 12,
};
assert_eq!(Ordering::Less, role_a.cmp(&role_b));
assert_eq!(Ordering::Greater, role_b.cmp(&role_a));
assert_eq!(Ordering::Equal, role_a.cmp(&role_a));
assert_eq!(Ordering::Equal, role_b.cmp(&role_b));

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 where
    Self: 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: &Self) -> 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::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for Role

impl StructuralEq for Role

impl StructuralPartialEq for Role