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/model/mod.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/model/mod.rs')
| -rw-r--r-- | src/model/mod.rs | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/src/model/mod.rs b/src/model/mod.rs index 3ea75c6..26c6f42 100644 --- a/src/model/mod.rs +++ b/src/model/mod.rs @@ -2,16 +2,16 @@ //! ease of use. //! //! Models can optionally have additional helper methods compiled, by enabling -//! the `methods` feature. +//! the `model` feature. //! //! Methods like [`Message::delete`] or [`Webhook::execute`] are provided with //! this feature, which can be shorthands for operations that are otherwise in -//! the [`Context`], or the much lower-level [`rest`] module. +//! the [`Context`], or the much lower-level [`http`] module. //! //! [`Context`]: ../client/struct.Context.html //! [`Message::delete`]: struct.Message.html#method.delete //! [`Webhook::execute`]: struct.Webhook.html#method.execute -//! [`rest`]: ../client/rest/index.html +//! [`http`]: ../http/index.html #[macro_use] mod utils; @@ -20,6 +20,7 @@ pub mod event; pub mod permissions; mod channel; +mod error; mod gateway; mod guild; mod invite; @@ -29,6 +30,7 @@ mod voice; mod webhook; pub use self::channel::*; +pub use self::error::Error as ModelError; pub use self::gateway::*; pub use self::guild::*; pub use self::invite::*; @@ -45,6 +47,8 @@ use std::fmt::{Formatter, Result as FmtResult}; use std::sync::{Arc, RwLock}; use time::Timespec; use ::internal::prelude::*; + +#[cfg(feature="utils")] use ::utils::Colour; fn default_true() -> bool { true } |