Merge pull request #1602 from CosmWasm/decimal-debug

Debug impl for Decimal/Decimal256 uses decimal output (Simon)

Author: webmaster128

CHANGELOG.md

@@ -13,6 +13,13 @@ and this project adheres to
 
 [#1597]: https://github.com/CosmWasm/cosmwasm/issues/1597
 
+### Changed
+
+- cosmwasm-std: Improve readability of `Debug` output for `Decimal` and
+  `Decimal256` ([#1600]).
+
+[#1600]: https://github.com/CosmWasm/cosmwasm/pull/1600
+
 ## [1.2.0] - 2023-01-24
 
 ### Added

packages/std/src/math/decimal.rs

@@ -19,7 +19,7 @@ use super::{Uint128, Uint256};
 /// A fixed-point decimal value with 18 fractional digits, i.e. Decimal(1_000_000_000_000_000_000) == 1.0
 ///
 /// The greatest possible value that can be represented is 340282366920938463463.374607431768211455 (which is (2^128 - 1) / 10^18)
-#[derive(Copy, Clone, Default, Debug, PartialEq, Eq, PartialOrd, Ord, JsonSchema)]
+#[derive(Copy, Clone, Default, PartialEq, Eq, PartialOrd, Ord, JsonSchema)]
 pub struct Decimal(#[schemars(with = "String")] Uint128);
 
 #[derive(Error, Debug, PartialEq, Eq)]
@@ -457,6 +457,12 @@ impl fmt::Display for Decimal {
     }
 }
 
+impl fmt::Debug for Decimal {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        write!(f, "Decimal({})", self)
+    }
+}
+
 impl Add for Decimal {
     type Output = Self;
 
@@ -2015,4 +2021,17 @@ mod tests {
             assert_eq!(&lhs == &rhs, expected);
         }
     }
+
+    #[test]
+    fn decimal_implements_debug() {
+        let decimal = Decimal::from_str("123.45").unwrap();
+        assert_eq!(format!("{:?}", decimal), "Decimal(123.45)");
+
+        let test_cases = ["5", "5.01", "42", "0", "2"];
+        for s in test_cases {
+            let decimal = Decimal::from_str(s).unwrap();
+            let expected = format!("Decimal({})", s);
+            assert_eq!(format!("{:?}", decimal), expected);
+        }
+    }
 }

packages/std/src/math/decimal256.rs

@@ -22,7 +22,7 @@ use super::Uint256;
 /// The greatest possible value that can be represented is
 /// 115792089237316195423570985008687907853269984665640564039457.584007913129639935
 /// (which is (2^256 - 1) / 10^18)
-#[derive(Copy, Clone, Default, Debug, PartialEq, Eq, PartialOrd, Ord, JsonSchema)]
+#[derive(Copy, Clone, Default, PartialEq, Eq, PartialOrd, Ord, JsonSchema)]
 pub struct Decimal256(#[schemars(with = "String")] Uint256);
 
 #[derive(Error, Debug, PartialEq, Eq)]
@@ -482,6 +482,12 @@ impl fmt::Display for Decimal256 {
     }
 }
 
+impl fmt::Debug for Decimal256 {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        write!(f, "Decimal256({})", self)
+    }
+}
+
 impl Add for Decimal256 {
     type Output = Self;
 
@@ -2162,4 +2168,17 @@ mod tests {
             assert_eq!(&lhs == &rhs, expected);
         }
     }
+
+    #[test]
+    fn decimal256_implements_debug() {
+        let decimal = Decimal256::from_str("123.45").unwrap();
+        assert_eq!(format!("{:?}", decimal), "Decimal256(123.45)");
+
+        let test_cases = ["5", "5.01", "42", "0", "2"];
+        for s in test_cases {
+            let decimal256 = Decimal256::from_str(s).unwrap();
+            let expected = format!("Decimal256({})", s);
+            assert_eq!(format!("{:?}", decimal256), expected);
+        }
+    }
 }