Merge #45: Implement std::error::Error for Error

814cd71 Implement std::error::Error for Error (Tobin C. Harding)

Pull request description:

  So that the usage of `bitcoinconsensus::Error` is more ergonomic for downstream users implement `std::error::Error`.

ACKs for top commit:
  apoelstra:
    utACK 814cd71

Tree-SHA512: 931e384eda3a0841ba7dfc9241f33fda2f02e11d85146cc8b8d2e79838419ccb852f3d98e8d35a5afd91179b0b490c258dec88c10d5a27e780918cb099cb98e2

Author: tcharding

Cargo.toml

@@ -18,6 +18,8 @@ name = "bitcoinconsensus"
 path = "src/lib.rs"
 
 [features]
+default = ["std"]
+std = []
 external-secp = []
 
 [dependencies]

src/lib.rs

@@ -20,19 +20,59 @@
 extern crate libc;
 
 use libc::{c_int,c_uchar, c_uint};
+use core::fmt;
 
+/// Errors returned by `libbitcoinconsensus` (see github.com/bitcoin/bitcoin/doc/shared-libraries.md).
 #[allow(non_camel_case_types)]
 #[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Clone, Copy)]
 #[repr(C)]
 pub enum Error {
+    /// Default value, passed to `libbitcoinconsensus` as a return parameter.
     ERR_SCRIPT = 0,
+    /// An invalid index for `txTo`.
     ERR_TX_INDEX,
+    /// `txToLen` did not match with the size of `txTo`.
     ERR_TX_SIZE_MISMATCH,
+    /// An error deserializing `txTo`.
     ERR_TX_DESERIALIZE,
+    /// Input amount is required if WITNESS is used.
     ERR_AMOUNT_REQUIRED,
+    /// Script verification `flags` are invalid (i.e. not part of the libconsensus interface).
     ERR_INVALID_FLAGS
 }
 
+impl fmt::Display for Error {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        use self::Error::*;
+
+        let s = match *self {
+            ERR_SCRIPT => "error value was not set (value still 0)",
+            ERR_TX_INDEX => "an invalid index for txTo",
+            ERR_TX_SIZE_MISMATCH => "txToLen did not match with the size of txTo",
+            ERR_TX_DESERIALIZE => "an error deserializing txTo",
+            ERR_AMOUNT_REQUIRED => "input amount is required if WITNESS is used",
+            ERR_INVALID_FLAGS => "script verification flags are invalid",
+        };
+        f.write_str(s)
+    }
+}
+
+#[cfg(feature = "std")]
+impl std::error::Error for Error {
+    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
+        use self::Error::*;
+
+        match *self {
+            ERR_SCRIPT
+            | ERR_TX_INDEX
+            | ERR_TX_SIZE_MISMATCH
+            | ERR_TX_DESERIALIZE
+            | ERR_AMOUNT_REQUIRED
+            | ERR_INVALID_FLAGS => None,
+        }
+    }
+}
+
 /// Do not enable any verification.
 pub const VERIFY_NONE : c_uint = 0;
 /// Evaluate P2SH (BIP16) subscripts.