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

use amq_protocol::{
  frame::GenError,
  protocol::AMQPClass,
};
use failure::{Backtrace, Context, Fail};

use std::{fmt, io};

use crate::connection_status::ConnectionState;

/// The type of error that can be returned in this crate.
///
/// Instead of implementing the `Error` trait provided by the standard library,
/// it implemented the `Fail` trait provided by the `failure` crate. Doing so
/// means that this type guaranteed to be both sendable and usable across
/// threads, and that you'll be able to use the downcasting feature of the
/// `failure::Error` type.
#[derive(Debug)]
pub struct Error {
  inner: Context<ErrorKind>,
}

/// The different kinds of errors that can be reported.
///
/// Even though we expose the complete enumeration of possible error variants, it is not
/// considered stable to exhaustively match on this enumeration: do it at your own risk.
#[derive(Debug, Fail)]
pub enum ErrorKind {
  #[fail(display = "output buffer is too small")]
  SendBufferTooSmall,
  #[fail(display = "input buffer is too small")]
  ReceiveBufferTooSmall,
  #[fail(display = "invalid protocol method: {:?}", _0)]
  InvalidMethod(AMQPClass),
  #[fail(display = "invalid channel: {}", _0)]
  InvalidChannel(u16),
  #[fail(display = "not connected")]
  NotConnected,
  #[fail(display = "unexpected reply")]
  UnexpectedReply,
  #[fail(display = "precondition failed")]
  PreconditionFailed,
  #[fail(display = "The maximum number of channels for this connection has been reached")]
  ChannelLimitReached,
  #[fail(display = "invalid connection state: {:?}", _0)]
  InvalidConnectionState(ConnectionState),
  #[fail(display = "Failed to parse: {}", _0)]
  ParsingError(String),
  #[fail(display = "Failed to serialise: {:?}", _0)]
  SerialisationError(#[fail(cause)] GenError),
  #[fail(display = "no new message")]
  NoNewMessage,
  #[fail(display = "IO error: {:?}", _0)]
  IOError(#[fail(cause)] io::Error),
  /// A hack to prevent developers from exhaustively match on the enum's variants
  ///
  /// The purpose of this variant is to let the `ErrorKind` enumeration grow more variants
  /// without it being a breaking change for users. It is planned for the language to provide
  /// this functionnality out of the box, though it has not been [stabilized] yet.
  ///
  /// [stabilized]: https://github.com/rust-lang/rust/issues/44109
  #[doc(hidden)]
  #[fail(display = "lapin_async::error::ErrorKind::__Nonexhaustive: this should not be printed")]
  __Nonexhaustive,
}

impl Error {
  /// Return the underlying `ErrorKind`
  pub fn kind(&self) -> &ErrorKind {
    self.inner.get_context()
  }
}

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

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

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

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

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