aboutsummaryrefslogtreecommitdiff
path: root/src/gateway/error.rs
blob: 374c4a31c23a94640aeb5cd1636ad3bcb75aeffb (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
use std::error::Error as StdError;
use std::fmt::{self, Display};
use websocket::message::CloseData;

/// 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 {
    /// There was an error building a URL.
    BuildingUrl,
    /// The connection closed, potentially uncleanly.
    Closed(Option<CloseData>),
    /// Expected a Hello during a handshake
    ExpectedHello,
    /// When there was an error sending a heartbeat.
    HeartbeatFailed,
    /// Expected a Ready or an InvalidateSession
    InvalidHandshake,
    /// An indicator that an unknown opcode was received from the gateway.
    InvalidOpCode,
    /// When a session Id was expected (for resuming), but was not present.
    NoSessionId,
    /// Failed to reconnect after a number of attempts.
    ReconnectFailure,
}

impl Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str(self.description())
    }
}

impl StdError for Error {
    fn description(&self) -> &str {
        match *self {
            Error::BuildingUrl => "Error building url",
            Error::Closed(_) => "Connection closed",
            Error::ExpectedHello => "Expected a Hello",
            Error::HeartbeatFailed => "Failed sending a heartbeat",
            Error::InvalidHandshake => "Expected a valid Handshake",
            Error::InvalidOpCode => "Invalid OpCode",
            Error::NoSessionId => "No Session Id present when required",
            Error::ReconnectFailure => "Failed to Reconnect",
        }
    }
}