diff options
| author | Austin Hellyer <[email protected]> | 2016-11-26 11:37:18 -0800 |
|---|---|---|
| committer | Austin Hellyer <[email protected]> | 2016-11-26 11:37:18 -0800 |
| commit | 77354ab321bec1ff66af0e27eb87a7eec3e3db24 (patch) | |
| tree | 693b43ae7be07be11426faf6e6282d838e426a04 /src/client/gateway/error.rs | |
| parent | Make Cache::get_channel return a reference (diff) | |
| download | serenity-77354ab321bec1ff66af0e27eb87a7eec3e3db24.tar.xz serenity-77354ab321bec1ff66af0e27eb87a7eec3e3db24.zip | |
Add a bit more docs
Diffstat (limited to 'src/client/gateway/error.rs')
| -rw-r--r-- | src/client/gateway/error.rs | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/src/client/gateway/error.rs b/src/client/gateway/error.rs index fb44d3f..dc94209 100644 --- a/src/client/gateway/error.rs +++ b/src/client/gateway/error.rs @@ -1,8 +1,12 @@ use std::fmt::{self, Display}; +/// An error that occurred while attempting to deal with the gateway. +/// +/// Note that - from a user standpoint - there should be no situation in which +/// you manually handle these. #[derive(Clone, Debug)] pub enum Error { - /// The connection closed + /// The connection unexpectedly (read: non-cleanly) closed. Closed(Option<u16>, String), /// Expected a Hello during a handshake ExpectedHello, |