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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
use std::collections::HashMap;
use crate::json::{from_number, json, Value};
use crate::model::prelude::*;
/// A builder for creating a new [`GuildChannel`] in a [`Guild`].
///
/// Except [`Self::name`], all fields are optional.
///
/// [`GuildChannel`]: crate::model::channel::GuildChannel
/// [`Guild`]: crate::model::guild::Guild
#[derive(Debug, Clone)]
pub struct CreateChannel(pub HashMap<&'static str, Value>);
impl CreateChannel {
/// Specify how to call this new channel.
///
/// **Note**: Must be between 2 and 100 characters long.
pub fn name<D: ToString>(&mut self, name: D) -> &mut Self {
self.0.insert("name", Value::from(name.to_string()));
self
}
/// Specify what type the channel is, whether it's a text, voice, category or news channel.
pub fn kind(&mut self, kind: ChannelType) -> &mut Self {
self.0.insert("type", from_number(kind as u8));
self
}
/// Specify the category, the "parent" of this channel.
pub fn category<I: Into<ChannelId>>(&mut self, id: I) -> &mut Self {
self.0.insert("parent_id", from_number(id.into().0));
self
}
/// Set an interesting topic.
///
/// **Note**: Must be between 0 and 1000 characters long.
pub fn topic<D: ToString>(&mut self, topic: D) -> &mut Self {
self.0.insert("topic", Value::from(topic.to_string()));
self
}
/// Specify if this channel will be inappropriate to browse while at work.
pub fn nsfw(&mut self, b: bool) -> &mut Self {
self.0.insert("nsfw", Value::from(b));
self
}
/// [Voice-only] Specify the bitrate at which sound plays in the voice channel.
pub fn bitrate(&mut self, rate: u32) -> &mut Self {
self.0.insert("bitrate", from_number(rate));
self
}
/// [Voice-only] Set how many users may occupy this voice channel.
pub fn user_limit(&mut self, limit: u32) -> &mut Self {
self.0.insert("user_limit", from_number(limit));
self
}
/// How many seconds must a user wait before sending another message.
///
/// Bots, or users with the [`MANAGE_MESSAGES`] and/or [`MANAGE_CHANNELS`] permissions are exempt
/// from this restriction.
///
/// **Note**: Must be between 0 and 21600 seconds (360 minutes or 6 hours).
///
/// [`MANAGE_MESSAGES`]: crate::model::permissions::Permissions::MANAGE_MESSAGES
/// [`MANAGE_CHANNELS`]: crate::model::permissions::Permissions::MANAGE_CHANNELS
#[doc(alias = "slowmode")]
pub fn rate_limit_per_user(&mut self, seconds: u64) -> &mut Self {
self.0.insert("rate_limit_per_user", from_number(seconds));
self
}
/// Specify where the channel should be located.
pub fn position(&mut self, pos: u32) -> &mut Self {
self.0.insert("position", from_number(pos));
self
}
/// A set of overwrites defining what a user or a user carrying a certain role can
/// and cannot do.
///
/// # Example
///
/// Inheriting permissions from an existing channel:
///
/// ```rust,no_run
/// # use serenity::{http::Http, model::id::GuildId};
/// # use std::sync::Arc;
/// #
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// # let http = Arc::new(Http::new("token"));
/// # let mut guild = GuildId(0).to_partial_guild(&http).await?;
/// use serenity::model::channel::{PermissionOverwrite, PermissionOverwriteType};
/// use serenity::model::id::UserId;
/// use serenity::model::permissions::Permissions;
///
/// // Assuming a guild has already been bound.
/// let permissions = vec![PermissionOverwrite {
/// allow: Permissions::VIEW_CHANNEL,
/// deny: Permissions::SEND_TTS_MESSAGES,
/// kind: PermissionOverwriteType::Member(UserId(1234)),
/// }];
///
/// guild.create_channel(http, |c| c.name("my_new_cool_channel").permissions(permissions)).await?;
/// # Ok(())
/// # }
/// ```
pub fn permissions<I>(&mut self, perms: I) -> &mut Self
where
I: IntoIterator<Item = PermissionOverwrite>,
{
let overwrites = perms
.into_iter()
.map(|perm| {
let (id, kind) = match perm.kind {
PermissionOverwriteType::Role(id) => (id.0, 0),
PermissionOverwriteType::Member(id) => (id.0, 1),
};
json!({
"allow": perm.allow.bits(),
"deny": perm.deny.bits(),
"id": id,
"type": kind,
})
})
.collect::<Vec<_>>();
self.0.insert("permission_overwrites", Value::from(overwrites));
self
}
}
impl Default for CreateChannel {
/// Creates a builder with default values, setting [`Self::kind`] to [`ChannelType::Text`].
///
/// # Examples
///
/// Create a default [`CreateChannel`] builder:
///
/// ```rust
/// use serenity::builder::CreateChannel;
///
/// let channel_builder = CreateChannel::default();
/// ```
fn default() -> Self {
let mut builder = CreateChannel(HashMap::new());
builder.kind(ChannelType::Text);
builder
}
}