diff options
| author | Zeyla Hellyer <[email protected]> | 2017-05-22 17:02:00 -0700 |
|---|---|---|
| committer | Zeyla Hellyer <[email protected]> | 2017-05-22 17:02:00 -0700 |
| commit | 9969be60cf320797c37b317da24d9a08fd5eafa5 (patch) | |
| tree | f27bf7a57af95bbc11990b1edcea9cca99276964 /src/builder/edit_member.rs | |
| parent | Reasonably derive Debug on items (diff) | |
| download | serenity-9969be60cf320797c37b317da24d9a08fd5eafa5.tar.xz serenity-9969be60cf320797c37b317da24d9a08fd5eafa5.zip | |
Restructure modules
Modules are now separated into a fashion where the library can be used
for most use cases, without needing to compile the rest.
The core of serenity, with no features enabled, contains only the
struct (model) definitions, constants, and prelude. Models do not have
most functions compiled in, as that is separated into the `model`
feature.
The `client` module has been split into 3 modules: `client`, `gateway`,
and `http`.
`http` contains functions to interact with the REST API. `gateway`
contains the Shard to interact with the gateway, requiring `http` for
retrieving the gateway URL. `client` requires both of the other features
and acts as an abstracted interface over both the gateway and REST APIs,
handling the event loop.
The `builder` module has been separated from `utils`, and can now be
optionally compiled in. It and the `http` feature are required by the
`model` feature due to a large number of methods requiring access to
them.
`utils` now contains a number of utilities, such as the Colour struct, the
`MessageBuilder`, and mention parsing functions.
Each of the original `ext` modules are still featured, with `cache` not
requiring any feature to be enabled, `framework` requiring the `client`,
`model`, and `utils`, and `voice` requiring `gateway`.
In total the features and their requirements are:
- `builder`: none
- `cache`: none
- `client`: `gateway`, `http`
- `framework`: `client`, `model`, `utils`
- `gateway`: `http`
- `http`: none
- `model`: `builder`, `http`
- `utils`: none
- `voice`: `gateway`
The default features are `builder`, `cache`, `client`, `framework`,
`gateway`, `model`, `http`, and `utils`.
To help with forwards compatibility, modules have been re-exported from
their original locations.
Diffstat (limited to 'src/builder/edit_member.rs')
| -rw-r--r-- | src/builder/edit_member.rs | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/src/builder/edit_member.rs b/src/builder/edit_member.rs new file mode 100644 index 0000000..044d8f2 --- /dev/null +++ b/src/builder/edit_member.rs @@ -0,0 +1,71 @@ +use ::model::{ChannelId, RoleId}; +use ::internal::prelude::*; + +/// A builder which edits the properties of a [`Member`], to be used in +/// conjunction with [`Context::edit_member`] and [`Member::edit`]. +/// +/// [`Context::edit_member`]: ../client/struct.Context.html#method.edit_member +/// [`Member`]: ../model/struct.Member.html +/// [`Member::edit`]: ../model/struct.Member.html#method.edit +#[derive(Clone, Debug, Default)] +pub struct EditMember(pub JsonMap); + +impl EditMember { + /// Whether to deafen the member. + /// + /// Requires the [Deafen Members] permission. + /// + /// [Deafen Members]: ../model/permissions/constant.DEAFEN_MEMBERS.html + pub fn deafen(mut self, deafen: bool) -> Self { + self.0.insert("deaf".to_owned(), Value::Bool(deafen)); + + self + } + + /// Whether to mute the member. + /// + /// Requires the [Mute Members] permission. + /// + /// [Mute Members]: ../model/permissions/constant.MUTE_MEMBERS.html + pub fn mute(mut self, mute: bool) -> Self { + self.0.insert("mute".to_owned(), Value::Bool(mute)); + + self + } + + /// Changes the member's nickname. Pass an empty string to reset the + /// nickname. + /// + /// Requires the [Manage Nicknames] permission. + /// + /// [Manage Nicknames]: ../model/permissions/constant.MANAGE_NICKNAMES.html + pub fn nickname(mut self, nickname: &str) -> Self { + self.0.insert("nick".to_owned(), Value::String(nickname.to_owned())); + + self + } + + /// Set the list of roles that the member should have. + /// + /// Requires the [Manage Roles] permission to modify. + /// + /// [Manage Roles]: ../model/permissions/constant.MANAGE_ROLES.html + pub fn roles(mut self, roles: &[RoleId]) -> Self { + let role_ids = roles.iter().map(|x| Value::Number(Number::from(x.0))).collect(); + + self.0.insert("roles".to_owned(), Value::Array(role_ids)); + + self + } + + /// The Id of the voice channel to move the member to. + /// + /// Requires the [Move Members] permission. + /// + /// [Move Members]: ../model/permissions/constant.MOVE_MEMBERS.html + pub fn voice_channel<C: Into<ChannelId>>(mut self, channel_id: C) -> Self { + self.0.insert("channel_id".to_owned(), Value::Number(Number::from(channel_id.into().0))); + + self + } +} |