spectacles-model 0.2.0

Discord types and structures for Spectacles.rs.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

use crate::snowflake::Snowflake;

/// Represents a Discord Role.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct Role {
    /// The snowflake ID of this role.
    pub id: Snowflake,
    /// The name of this role.
    pub name: String,
    /// The hexadecimal color code for this role.
    pub color: i32,
    /// whether or not this role is hoisted.
    #[serde(rename = "hoist")]
    pub hoisted: bool,
    /// The position of this role.
    pub position: i32,
    /// Whether or not this role is managed by an integration.
    pub managed: bool,
    /// Whether or not this role is mentionable.
    pub mentionable: bool
}

/// Options for creating a role in a guild.
#[derive(Clone, Debug, Deserialize, Serialize, Default)]
pub struct CreateRoleOptions {
    #[serde(skip_serializing_if = "Option::is_none")]
    name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    permissions: Option<i32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    color: Option<i32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    hoist: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    mentionable: Option<bool>,
}

impl CreateRoleOptions {
    /// Sets the name of the role.
    pub fn name(mut self, name: &str) -> Self {
        self.name = Some(name.to_string());
        self
    }

    /// Sets the permissions that this role should have.
    pub fn permissions(mut self, perms: i32) -> Self {
        self.permissions = Some(perms);
        self
    }

    /// Sets the color of the role.
    pub fn color(mut self, clr: i32) -> Self {
        self.color = Some(clr);
        self
    }

    /// Sets the hoisted status of this role.
    pub fn hoisted(mut self, opt: bool) -> Self {
        self.hoist = Some(opt);
        self
    }

    /// Sets the mentionable status of this user.
    pub fn mentionable(mut self, opt: bool) -> Self {
        self.mentionable = Some(opt);
        self
    }
}

/// Options for modifying a role in a guild.
#[derive(Clone, Debug, Deserialize, Serialize, Default)]
pub struct ModifyRoleOptions {
    #[serde(skip_serializing_if = "Option::is_none")]
    name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    permissions: Option<i32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    color: Option<i32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    hoist: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    mentionable: Option<bool>,
}

impl ModifyRoleOptions {
    /// Sets a new name for the role.
    pub fn name(mut self, name: &str) -> Self {
        self.name = Some(name.to_string());
        self
    }

    /// Sets the new permissions for the role.
    pub fn permissions(mut self, perms: i32) -> Self {
        self.permissions = Some(perms);
        self
    }

    /// Sets the new color of the role.
    pub fn color(mut self, clr: i32) -> Self {
        self.color = Some(clr);
        self
    }

    /// Sets the hoist status of this role.
    pub fn hoisted(mut self, opt: bool) -> Self {
        self.hoist = Some(opt);
        self
    }

    /// Sets the mentionable status of this role.
    pub fn mentionable(mut self, opt: bool) -> Self {
        self.mentionable = Some(opt);
        self
    }
}

/// Represents a packet sent by the gateway when a guild role is created/updated.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct GuildRoleCreateOrUpdate {
    /// The guild ID of the guild.
    pub guild_id: Snowflake,
    /// The role that was created.
    pub role: Role
}

/// Represents a packet sent by the gateway when a guild role is deleted.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct GuildRoleDelete {
    /// The guild ID of the guild.
    pub guild_id: Snowflake,
    /// The role ID of the role that was deleted.
    pub role_id: Snowflake
}