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/utils/builder/create_message.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/utils/builder/create_message.rs')
| -rw-r--r-- | src/utils/builder/create_message.rs | 86 |
1 files changed, 0 insertions, 86 deletions
diff --git a/src/utils/builder/create_message.rs b/src/utils/builder/create_message.rs deleted file mode 100644 index 5c3b6eb..0000000 --- a/src/utils/builder/create_message.rs +++ /dev/null @@ -1,86 +0,0 @@ -use super::CreateEmbed; -use ::internal::prelude::*; - -/// A builder to specify the contents of an [`rest::send_message`] request, -/// primarily meant for use through [`Context::send_message`]. -/// -/// There are two situations where different field requirements are present: -/// -/// 1. When sending an [`embed`], no other field is required; -/// 2. Otherwise, [`content`] is the only required field that is required to be -/// set. -/// -/// Note that if you only need to send the content of a message, without -/// specifying other fields, then [`Context::say`] may be a more preferable -/// option. -/// -/// # Examples -/// -/// Sending a message with a content of `"test"` and applying text-to-speech: -/// -/// ```rust,no_run -/// use serenity::model::ChannelId; -/// -/// let channel_id = ChannelId(7); -/// -/// let _ = channel_id.send_message(|m| m -/// .content("test") -/// .tts(true) -/// .embed(|e| e -/// .title("This is an embed") -/// .description("With a description"))); -/// ``` -/// -/// [`Context::say`]: ../../client/struct.Context.html#method.say -/// [`Context::send_message`]: ../../client/struct.Context.html#method.send_message -/// [`content`]: #method.content -/// [`embed`]: #method.embed -/// [`rest::send_message`]: ../../client/rest/fn.send_message.html -#[derive(Clone, Debug)] -pub struct CreateMessage(pub Map<String, Value>); - -impl CreateMessage { - /// Set the content of the message. - /// - /// **Note**: Message contents must be under 2000 unicode code points. - pub fn content(mut self, content: &str) -> Self { - self.0.insert("content".to_owned(), Value::String(content.to_owned())); - - CreateMessage(self.0) - } - - /// Set an embed for the message. - pub fn embed<F>(mut self, f: F) -> Self - where F: FnOnce(CreateEmbed) -> CreateEmbed { - let embed = Value::Object(f(CreateEmbed::default()).0); - - self.0.insert("embed".to_owned(), embed); - - CreateMessage(self.0) - } - - /// Set whether the message is text-to-speech. - /// - /// Think carefully before setting this to `true`. - /// - /// Defaults to `false`. - pub fn tts(mut self, tts: bool) -> Self { - self.0.insert("tts".to_owned(), Value::Bool(tts)); - - CreateMessage(self.0) - } -} - -impl Default for CreateMessage { - /// Creates a map for sending a [`Message`], setting [`tts`] to `false` by - /// default. - /// - /// [`Message`]: ../../model/struct.Message.html - /// [`tts`]: #method.tts - fn default() -> CreateMessage { - let mut map = Map::default(); - map.insert("tts".to_owned(), Value::Bool(false)); - - CreateMessage(map) - } -} |