aboutsummaryrefslogtreecommitdiff
path: root/src/utils/builder/edit_role.rs
blob: b4be6d4c1fd98071ec21a36cb1fc9e4d534c4d02 (plain) (blame)
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
use serde_json::builder::ObjectBuilder;
use std::default::Default;
use ::model::{Permissions, Role, permissions};

/// A builer to create or edit a [`Role`] for use via a number of model and
/// context methods.
///
/// These are:
///
/// - [`Context::create_role`]
/// - [`Context::edit_role`]
/// - [`Guild::create_role`]
/// - [`Role::edit`]
///
/// Defaults are provided for each parameter on role creation.
///
/// # Examples
///
/// Create a hoisted, mentionable role named "a test role":
///
/// ```rust,ignore
/// // assuming you are in a `context` and a `guild_id` has been bound
/// let role = context.create_role(guild_id, |r| r
///     .hoist(true)
///     .mentionable(true)
///     .name("a test role"));
/// ```
///
/// [`Context::create_role`]: ../client/struct.Context.html#method.create_role
/// [`Context::edit_role`]: ../client/struct.Context.html#method.edit_role
/// [`Guild::create_role`]: ../model/struct.Guild.html#method.create_role
/// [`Role`]: ../model/struct.Role.html
/// [`Role::edit`]: ../model/struct.Role.html#method.edit
pub struct EditRole(pub ObjectBuilder);

impl EditRole {
    /// Creates a new builder with the values of the given [`Role`].
    pub fn new(role: &Role) -> Self {
        EditRole(ObjectBuilder::new()
            .insert("color", role.colour.value)
            .insert("hoist", role.hoist)
            .insert("managed", role.managed)
            .insert("mentionable", role.mentionable)
            .insert("name", &role.name)
            .insert("permissions", role.permissions.bits())
            .insert("position", role.position))
    }

    /// Sets the colour of the role.
    pub fn colour(self, colour: u64) -> Self {
        EditRole(self.0.insert("color", colour))
    }

    /// Whether or not to hoist the role above lower-positioned role in the user
    /// list.
    pub fn hoist(self, hoist: bool) -> Self {
        EditRole(self.0.insert("hoist", hoist))
    }

    /// Whether or not to make the role mentionable, notifying its users.
    pub fn mentionable(self, mentionable: bool) -> Self {
        EditRole(self.0.insert("mentionable", mentionable))
    }

    /// The name of the role to set.
    pub fn name(self, name: &str) -> Self {
        EditRole(self.0.insert("name", name))
    }

    /// The set of permissions to assign the role.
    pub fn permissions(self, permissions: Permissions) -> Self {
        EditRole(self.0.insert("permissions", permissions.bits()))
    }

    /// The position to assign the role in the role list. This correlates to the
    /// role's position in the user list.
    pub fn position(self, position: u8) -> Self {
        EditRole(self.0.insert("position", position))
    }
}

impl Default for EditRole {
    /// Creates a builder with default parameters.
    ///
    /// The defaults are:
    ///
    /// - **color**: 10070709
    /// - **hoist**: false
    /// - **mentionable**: false
    /// - **name**: new role
    /// - **permissions**: the [general permissions set]
    /// - **position**: 1
    ///
    /// [general permissions set]: ../model/permissions/fn.general.html
    fn default() -> EditRole {
        EditRole(ObjectBuilder::new()
            .insert("color", 10070709)
            .insert("hoist", false)
            .insert("mentionable", false)
            .insert("name", "new role".to_owned())
            .insert("permissions", permissions::general().bits())
            .insert("position", 1))
    }
}