Merge pull request #58 from stevenroose/hex-error

Create a separate hex::Error type

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.7.0 - 2019-07-19
+
+* Add `hex::Error` type for errors generated by the `hex` module.
+
 # 0.6.0 - 2019-07-10
 
 * Add `no_std` support, rearrange traits to not depend on `io::Write`

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bitcoin_hashes"
-version = "0.6.0"
+version = "0.7.0"
 authors = ["Andrew Poelstra <apoelstra@wpsoftware.net>"]
 license = "CC0-1.0"
 description = "Hash functions used by rust-bitcoin which support rustc 1.14.0"

src/error.rs

@@ -17,30 +17,18 @@
 
 use core::fmt;
 
-/// Hex decoding error
-#[derive(Copy, Clone, PartialEq, Eq)]
+/// [bitcoin_hashes] error.
+#[derive(Debug, Copy, Clone, PartialEq, Eq)]
 pub enum Error {
-    /// non-hexadecimal character
-    InvalidChar(u8),
-    /// purported hex string had odd length
-    OddLengthString(usize),
-    /// tried to parse fixed-length hash from a string with the wrong type (expected, got)
+    /// Tried to create a fixed-length hash from a slice with the wrong size (expected, got).
     InvalidLength(usize, usize),
 }
 
-impl fmt::Debug for Error {
+impl fmt::Display for Error {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         match *self {
-            Error::InvalidChar(ch) => write!(f, "invalid hex character {}", ch),
-            Error::OddLengthString(ell) => write!(f, "odd hex string length {}", ell),
-            Error::InvalidLength(ell, ell2) => write!(f, "bad hex string length {} (expected {})", ell2, ell),
+            Error::InvalidLength(ell, ell2) => write!(f, "bad slice length {} (expected {})", ell2, ell),
         }
     }
 }
 
-impl fmt::Display for Error {
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        fmt::Debug::fmt(self, f)
-    }
-}
-

src/hash160.rs

@@ -38,8 +38,8 @@ serde_impl!(Hash, 20);
 borrow_slice_impl!(Hash);
 
 impl str::FromStr for Hash {
-    type Err = Error;
-    fn from_str(s: &str) -> Result<Self, Error> {
+    type Err = ::hex::Error;
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
         ::hex::FromHex::from_hex(s)
     }
 }

src/hex.rs

@@ -16,7 +16,28 @@
 //!
 
 use core::{fmt, str};
-use {Error, Hash};
+use Hash;
+
+/// Hex decoding error
+#[derive(Debug, Copy, Clone, PartialEq, Eq)]
+pub enum Error {
+    /// non-hexadecimal character
+    InvalidChar(u8),
+    /// purported hex string had odd length
+    OddLengthString(usize),
+    /// tried to parse fixed-length hash from a string with the wrong type (expected, got)
+    InvalidLength(usize, usize),
+}
+
+impl fmt::Display for Error {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        match *self {
+            Error::InvalidChar(ch) => write!(f, "invalid hex character {}", ch),
+            Error::OddLengthString(ell) => write!(f, "odd hex string length {}", ell),
+            Error::InvalidLength(ell, ell2) => write!(f, "bad hex string length {} (expected {})", ell2, ell),
+        }
+    }
+}
 
 /// Trait for objects that can be serialized as hex strings
 #[cfg(any(test, feature = "std"))]
@@ -220,10 +241,9 @@ impl_fromhex_array!(512);
 
 #[cfg(test)]
 mod tests {
-    use core::fmt;
+    use super::*;
 
-    use super::{format_hex, format_hex_reverse, FromHex, ToHex};
-    use Error;
+    use core::fmt;
 
     #[test]
     fn hex_roundtrip() {

src/ripemd160.rs

@@ -80,8 +80,8 @@ serde_impl!(Hash, 20);
 borrow_slice_impl!(Hash);
 
 impl str::FromStr for Hash {
-    type Err = Error;
-    fn from_str(s: &str) -> Result<Self, Error> {
+    type Err = ::hex::Error;
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
         ::hex::FromHex::from_hex(s)
     }
 }

src/sha1.rs

@@ -75,8 +75,8 @@ serde_impl!(Hash, 20);
 borrow_slice_impl!(Hash);
 
 impl str::FromStr for Hash {
-    type Err = Error;
-    fn from_str(s: &str) -> Result<Self, Error> {
+    type Err = ::hex::Error;
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
         ::hex::FromHex::from_hex(s)
     }
 }

src/sha256.rs

@@ -69,8 +69,8 @@ impl EngineTrait for HashEngine {
 pub struct Hash([u8; 32]);
 
 impl str::FromStr for Hash {
-    type Err = Error;
-    fn from_str(s: &str) -> Result<Self, Error> {
+    type Err = ::hex::Error;
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
         ::hex::FromHex::from_hex(s)
     }
 }
@@ -177,8 +177,8 @@ impl Midstate {
 }
 
 impl hex::FromHex for Midstate {
-    fn from_byte_iter<I>(iter: I) -> Result<Self, Error>
-        where I: Iterator<Item=Result<u8, Error>> +
+    fn from_byte_iter<I>(iter: I) -> Result<Self, hex::Error>
+        where I: Iterator<Item=Result<u8, hex::Error>> +
             ExactSizeIterator +
             DoubleEndedIterator,
     {

src/sha256d.rs

@@ -32,8 +32,8 @@ serde_impl!(Hash, 32);
 borrow_slice_impl!(Hash);
 
 impl str::FromStr for Hash {
-    type Err = Error;
-    fn from_str(s: &str) -> Result<Self, Error> {
+    type Err = ::hex::Error;
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
         ::hex::FromHex::from_hex(s)
     }
 }

src/sha512.rs

@@ -118,8 +118,8 @@ impl hash::Hash for Hash {
 }
 
 impl str::FromStr for Hash {
-    type Err = Error;
-    fn from_str(s: &str) -> Result<Self, Error> {
+    type Err = ::hex::Error;
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
         ::hex::FromHex::from_hex(s)
     }
 }

src/siphash24.rs

@@ -202,8 +202,8 @@ serde_impl!(Hash, 8);
 borrow_slice_impl!(Hash);
 
 impl str::FromStr for Hash {
-    type Err = Error;
-    fn from_str(s: &str) -> Result<Self, Error> {
+    type Err = ::hex::Error;
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
         ::hex::FromHex::from_hex(s)
     }
 }

src/std_impls.rs

@@ -18,7 +18,7 @@
 
 use std::{error, io};
 
-use {sha1, sha256, sha512, ripemd160, siphash24};
+use {hex, sha1, sha256, sha512, ripemd160, siphash24};
 use HashEngine;
 use Error;
 
@@ -27,6 +27,11 @@ impl error::Error for Error {
     fn description(&self) -> &str { "`std::error::description` is deprecated" }
 }
 
+impl error::Error for hex::Error {
+    fn cause(&self) -> Option<&error::Error> { None }
+    fn description(&self) -> &str { "`std::error::description` is deprecated" }
+}
+
 impl io::Write for sha1::HashEngine {
     fn flush(&mut self) -> io::Result<()> { Ok(()) }