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
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203

use failure::{Backtrace, Context, Fail};
use std::sync::Arc;
use std::{fmt, result};
use url::ParseError as UrlParseError;
use url::Url;

/// A type alias for handling errors throughout amiquip.
pub type Result<T> = result::Result<T, Error>;

/// An error that can occur from amiquip.
#[derive(Clone, Debug)]
pub struct Error {
    ctx: Arc<Context<ErrorKind>>,
}

impl Error {
    pub fn kind(&self) -> &ErrorKind {
        self.ctx.get_context()
    }
}

impl Fail for Error {
    fn cause(&self) -> Option<&Fail> {
        self.ctx.cause()
    }

    fn backtrace(&self) -> Option<&Backtrace> {
        self.ctx.backtrace()
    }
}

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

/// Specific error cases returned by amiquip.
#[derive(Clone, Debug, PartialEq, Fail)]
pub enum ErrorKind {
    /// URL parsing failed.
    #[fail(display = "could not parse url: {}", _0)]
    UrlParseError(UrlParseError),

    /// A TLS connection was requested (e.g., via URL), but the amiquip was built without TLS
    /// support.
    #[fail(display = "amiquip built without TLS support")]
    TlsFeatureNotEnabled,

    /// URL could not be decoded into an AMQP or AMQPS connection string.
    #[fail(display = "invalid url: {}", _0)]
    InvalidUrl(Url),

    /// An insecure URL was supplied to [`Connection::open`](struct.Connection.html#method.open),
    /// which only allows `amqps://...` URLs.
    #[fail(display = "insecure URL passed to method that only allows secure connections")]
    InsecureUrl,

    /// The underlying socket was closed.
    #[fail(display = "underlying socket closed unexpectedly")]
    UnexpectedSocketClose,

    /// We received data that could not be parsed as an AMQP frame.
    #[fail(display = "received malformed data - expected AMQP frame")]
    MalformedFrame,

    /// An I/O error occurred; the underlying cause will be an `io::Error`.
    #[fail(display = "I/O error")]
    Io,

    /// The TLS handshake failed.
    #[cfg(feature = "native-tls")]
    #[fail(display = "TLS handshake failed")]
    TlsHandshake,

    /// Error from underlying TLS implementation.
    #[cfg(feature = "native-tls")]
    #[fail(display = "TLS error: {}", _0)]
    TlsError(String),

    /// The server does not support the requested auth mechanism.
    #[fail(display = "requested auth mechanism unavailable (available = {})", _0)]
    UnsupportedAuthMechanism(String),

    /// The server does not support the requested locale.
    #[fail(display = "requested locale unavailable (available = {})", _0)]
    UnsupportedLocale(String),

    /// The requested frame size is smaller than the minimum required by AMQP.
    #[fail(display = "requested frame max is too small (min = {})", _0)]
    FrameMaxTooSmall(u32),

    /// Timeout occurred while performing the initial TCP connection.
    #[fail(display = "timeout occurred while waiting for TCP connection")]
    ConnectionTimeout,

    /// The server requested a Secure/Secure-Ok exchange, which are currently unsupported.
    #[fail(display = "SASL secure/secure-ok exchanges are not supported")]
    SaslSecureNotSupported,

    /// The supplied authentication credentials were not accepted by the server.
    #[fail(display = "invalid credentials")]
    InvalidCredentials,

    /// The server missed too many successive heartbeats.
    #[fail(display = "missed heartbeats from server")]
    MissedServerHeartbeats,

    /// The server closed the connection with the given reply code and text.
    #[fail(display = "server closed connection (code={} message={})", _0, _1)]
    ServerClosedConnection(u16, String),

    /// The client closed the connection.
    #[fail(display = "client closed connection")]
    ClientClosedConnection,

    /// The server closed the given channel with the given reply code and text.
    #[fail(display = "server closed channel {} (code={}, message={})", _0, _1, _2)]
    ServerClosedChannel(u16, u16, String),

    /// The client closed the channel.
    #[fail(display = "channel has been closed")]
    ClientClosedChannel,

    /// The I/O loop attempted to send a message to a caller that did not exist. This
    /// indicates either a bug in amiquip or a connection that is in a bad state and in the process
    /// of tearing down.
    #[fail(display = "i/o loop thread tried to communicate with a nonexistent client")]
    EventLoopClientDropped,

    /// The I/O loop has dropped the sending side of a channel, typically because it has exited due
    /// to another error.
    #[fail(display = "i/o loop dropped sending side of a channel")]
    EventLoopDropped,

    /// We received a valid AMQP frame but not one we expected; e.g., receiving an incorrect
    /// response to an AMQP method call.
    #[fail(display = "AMQP protocol error - received unexpected frame")]
    FrameUnexpected,

    /// Forking the I/O thread failed.
    #[fail(display = "fork failed")]
    ForkFailed,

    /// No more channels can be opened because there are already
    /// [`channel_max`](struct.ConnectionOptions.html#method.channel_max) channels open.
    #[fail(display = "no more channel ids are available")]
    ExhaustedChannelIds,

    /// An explicit channel ID was requested, but that channel is unavailable for use (e.g.,
    /// because there is another open channel with the same ID).
    #[fail(display = "requested channel id {} is unavailable", _0)]
    UnavailableChannelId(u16),

    /// The client sent an AMQP exception to the server and closed the connection.
    #[fail(display = "internal client exception - received unhandled frames from server")]
    ClientException,

    /// The server sent frames for a channel ID we don't know about.
    #[fail(display = "received message for nonexistent channel {}", _0)]
    ReceivedFrameWithBogusChannelId(u16),

    /// The I/O thread panicked.
    #[fail(display = "I/O thread panicked")]
    IoThreadPanic,

    /// The server sent us a consumer tag that is equal to another consumer tag we already have on
    /// the same channel.
    #[fail(
        display = "server sent duplicate consumer tag for channel {}: {}",
        _0, _1
    )]
    DuplicateConsumerTag(u16, String),

    /// The server sent us a [`Delivery`](struct.Delivery.html) for a channel we don't know about.
    #[fail(
        display = "received delivery with unknown consumer tag for channel {}: {}",
        _0, _1
    )]
    UnknownConsumerTag(u16, String),

    #[doc(hidden)]
    #[fail(display = "invalid error case")]
    __Nonexhaustive,
}

impl From<UrlParseError> for Error {
    fn from(err: UrlParseError) -> Error {
        Error::from(ErrorKind::UrlParseError(err))
    }
}

impl From<ErrorKind> for Error {
    fn from(kind: ErrorKind) -> Error {
        Error::from(Context::new(kind))
    }
}

impl From<Context<ErrorKind>> for Error {
    fn from(ctx: Context<ErrorKind>) -> Error {
        Error { ctx: Arc::new(ctx) }
    }
}