aboutsummaryrefslogtreecommitdiff
path: root/src/voice/error.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/voice/error.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/voice/error.rs')
-rw-r--r--src/voice/error.rs34
1 files changed, 34 insertions, 0 deletions
diff --git a/src/voice/error.rs b/src/voice/error.rs
new file mode 100644
index 0000000..55be1f6
--- /dev/null
+++ b/src/voice/error.rs
@@ -0,0 +1,34 @@
+use serde_json::Value;
+use std::process::Output;
+
+/// An error returned from the voice module.
+// Errors which are not visible to the end user are hidden.
+#[derive(Debug)]
+pub enum VoiceError {
+ /// An indicator that an endpoint URL was invalid.
+ EndpointUrl,
+ #[doc(hidden)]
+ ExpectedHandshake,
+ #[doc(hidden)]
+ FindingByte,
+ #[doc(hidden)]
+ HostnameResolve,
+ #[doc(hidden)]
+ KeyGen,
+ /// An error occurred while checking if a path is stereo.
+ Streams,
+ #[doc(hidden)]
+ VoiceModeInvalid,
+ #[doc(hidden)]
+ VoiceModeUnavailable,
+ /// An error occurred while running `youtube-dl`.
+ YouTubeDLRun(Output),
+ /// An error occurred while processing the JSON output from `youtube-dl`.
+ ///
+ /// The JSON output is given.
+ YouTubeDLProcessing(Value),
+ /// The `url` field of the `youtube-dl` JSON output was not present.
+ ///
+ /// The JSON output is given.
+ YouTubeDLUrl(Value),
+}