aboutsummaryrefslogtreecommitdiff
path: root/src/builder/create_invite.rs
diff options
context:
space:
mode:
authorZeyla Hellyer <[email protected]>2017-05-22 17:02:00 -0700
committerZeyla Hellyer <[email protected]>2017-05-22 17:02:00 -0700
commit9969be60cf320797c37b317da24d9a08fd5eafa5 (patch)
treef27bf7a57af95bbc11990b1edcea9cca99276964 /src/builder/create_invite.rs
parentReasonably derive Debug on items (diff)
downloadserenity-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/create_invite.rs')
-rw-r--r--src/builder/create_invite.rs84
1 files changed, 84 insertions, 0 deletions
diff --git a/src/builder/create_invite.rs b/src/builder/create_invite.rs
new file mode 100644
index 0000000..67e33fc
--- /dev/null
+++ b/src/builder/create_invite.rs
@@ -0,0 +1,84 @@
+use serde_json::Value;
+use std::default::Default;
+use ::internal::prelude::*;
+
+/// A builder to create a [`RichInvite`] for use via [`Context::create_invite`].
+///
+/// This is a structured and cleaner way of creating an invite, as all
+/// parameters are optional.
+///
+/// # Examples
+///
+/// Create an invite with a max age of 3600 seconds and 10 max uses:
+///
+/// ```rust,ignore
+/// use serenity::Client;
+/// use std::env;
+///
+/// let mut client = Client::login(&env::var("DISCORD_BOT_TOKEN").unwrap());
+///
+/// client.on_message(|_, message| {
+/// if message.content == "!invite" {
+/// let invite = message.channel_id.create_invite(|i| i
+/// .max_age(3600)
+/// .max_uses(10));
+/// }
+/// });
+/// ```
+///
+/// [`Context::create_invite`]: ../client/struct.Context.html#method.create_invite
+/// [`RichInvite`]: ../model/struct.Invite.html
+#[derive(Clone, Debug)]
+pub struct CreateInvite(pub JsonMap);
+
+impl CreateInvite {
+ /// The duration that the invite will be valid for.
+ ///
+ /// Set to `0` for an invite which does not expire after an amount of time.
+ ///
+ /// Defaults to `86400`, or 24 hours.
+ pub fn max_age(mut self, max_age: u64) -> Self {
+ self.0.insert("max_age".to_owned(), Value::Number(Number::from(max_age)));
+
+ self
+ }
+
+ /// The number of uses that the invite will be valid for.
+ ///
+ /// Set to `0` for an invite which does not expire after a number of uses.
+ ///
+ /// Defaults to `0`.
+ pub fn max_uses(mut self, max_uses: u64) -> Self {
+ self.0.insert("max_uses".to_owned(), Value::Number(Number::from(max_uses)));
+
+ self
+ }
+
+ /// Whether an invite grants a temporary membership.
+ ///
+ /// Defaults to `false`.
+ pub fn temporary(mut self, temporary: bool) -> Self {
+ self.0.insert("temporary".to_owned(), Value::Bool(temporary));
+
+ self
+ }
+
+ /// Whether or not to try to reuse a similar invite.
+ ///
+ /// Defaults to `false`.
+ pub fn unique(mut self, unique: bool) -> Self {
+ self.0.insert("unique".to_owned(), Value::Bool(unique));
+
+ self
+ }
+}
+
+impl Default for CreateInvite {
+ /// Creates a builder with default values, setting `validate` to `null`.
+ fn default() -> CreateInvite {
+ let mut map = Map::new();
+ map.insert("validate".to_owned(), Value::Null);
+
+ CreateInvite(map)
+ }
+}