Merge branch 'copilot/add-hashable-instances'

Author: nikita-volkov

postgresql-types.cabal

@@ -159,6 +159,7 @@ library
     base >=4.11 && <5,
     bytestring >=0.10 && <0.13,
     containers >=0.6 && <0.9,
+    hashable >=1.3 && <2,
     invariant ^>=0.6.4,
     jsonifier ^>=0.2.1.3,
     mtl >=2.2 && <3,

src/library/PostgresqlTypes/Bit.hs

@@ -16,6 +16,7 @@ where
 import qualified Data.Attoparsec.Text as Attoparsec
 import qualified Data.Bits as Bits
 import qualified Data.ByteString as ByteString
+import Data.Hashable (Hashable (..))
 import qualified Data.Text as Text
 import qualified Data.Vector.Generic as Vg
 import qualified GHC.TypeLits as TypeLits
@@ -48,6 +49,9 @@ instance (TypeLits.KnownNat numBits) => Arbitrary (Bit numBits) where
       Nothing -> error "Arbitrary Bit: Generated bit string has incorrect length"
       Just bit -> pure bit
 
+instance Hashable (Bit numBits) where
+  hashWithSalt salt (Bit bytes) = hashWithSalt salt bytes
+
 instance (TypeLits.KnownNat numBits) => IsScalar (Bit numBits) where
   schemaName = Tagged Nothing
   typeName = Tagged "bit"

src/library/PostgresqlTypes/Bool.hs

@@ -11,6 +11,7 @@ where
 
 import qualified Data.Attoparsec.Text as Attoparsec
 import qualified Data.Bool
+import Data.Hashable (Hashable)
 import PostgresqlTypes.Algebra
 import PostgresqlTypes.Prelude hiding (Bool)
 import PostgresqlTypes.Via
@@ -21,7 +22,7 @@ import qualified PtrPoker.Write as Write
 --
 -- [PostgreSQL docs](https://www.postgresql.org/docs/18/datatype-boolean.html).
 newtype Bool = Bool Data.Bool.Bool
-  deriving newtype (Eq, Ord, Arbitrary)
+  deriving newtype (Eq, Ord, Hashable, Arbitrary)
   deriving (Show, Read, IsString) via (ViaIsScalar Bool)
 
 instance IsScalar Bool where

src/library/PostgresqlTypes/Box.hs

@@ -14,6 +14,7 @@ module PostgresqlTypes.Box
 where
 
 import qualified Data.Attoparsec.Text as Attoparsec
+import Data.Hashable (Hashable (..))
 import GHC.Float (castDoubleToWord64, castWord64ToDouble)
 import PostgresqlTypes.Algebra
 import PostgresqlTypes.Prelude
@@ -55,6 +56,13 @@ instance Arbitrary Box where
     | (x1', y1', x2', y2') <- shrink (x1, y1, x2, y2)
     ]
 
+instance Hashable Box where
+  hashWithSalt salt (Box x1 y1 x2 y2) =
+    salt `hashWithSalt` castDoubleToWord64 x1
+      `hashWithSalt` castDoubleToWord64 y1
+      `hashWithSalt` castDoubleToWord64 x2
+      `hashWithSalt` castDoubleToWord64 y2
+
 instance IsScalar Box where
   schemaName = Tagged Nothing
   typeName = Tagged "box"

src/library/PostgresqlTypes/Bpchar.hs

@@ -14,6 +14,7 @@ module PostgresqlTypes.Bpchar
 where
 
 import qualified Data.Attoparsec.Text as Attoparsec
+import Data.Hashable (Hashable (..))
 import Data.String
 import qualified Data.Text as Text
 import qualified Data.Text.Encoding as Text.Encoding
@@ -55,6 +56,9 @@ instance (TypeLits.KnownNat numChars) => Arbitrary (Bpchar numChars) where
       Nothing -> error "Arbitrary Bpchar: Generated string has incorrect length"
       Just char -> pure char
 
+instance Hashable (Bpchar numChars) where
+  hashWithSalt salt (Bpchar txt) = hashWithSalt salt txt
+
 instance (TypeLits.KnownNat numChars) => IsScalar (Bpchar numChars) where
   schemaName = Tagged Nothing
   typeName = Tagged "bpchar"

src/library/PostgresqlTypes/Bytea.hs

@@ -11,6 +11,7 @@ where
 
 import qualified Data.Attoparsec.Text as Attoparsec
 import qualified Data.ByteString as ByteString
+import Data.Hashable (Hashable)
 import qualified Data.Text as Text
 import PostgresqlTypes.Algebra
 import PostgresqlTypes.Prelude
@@ -23,7 +24,7 @@ import qualified TextBuilder
 --
 -- [PostgreSQL docs](https://www.postgresql.org/docs/18/datatype-binary.html).
 newtype Bytea = Bytea ByteString
-  deriving newtype (Eq, Ord, Arbitrary)
+  deriving newtype (Eq, Ord, Hashable, Arbitrary)
   deriving (Show, Read, IsString) via (ViaIsScalar Bytea)
 
 instance IsScalar Bytea where

src/library/PostgresqlTypes/Char.hs

@@ -15,6 +15,7 @@ where
 
 import qualified Data.Attoparsec.Text as Attoparsec
 import qualified Data.Char
+import Data.Hashable (Hashable)
 import PostgresqlTypes.Algebra
 import PostgresqlTypes.Prelude hiding (Char)
 import PostgresqlTypes.Via
@@ -41,7 +42,7 @@ import qualified TextBuilder
 -- @'PostgresqlTypes.Bpchar.Bpchar' 1@ in Haskell. Despite the similar names,
 -- these are entirely different types in PostgreSQL.
 newtype Char = Char Word8
-  deriving newtype (Eq, Ord)
+  deriving newtype (Eq, Ord, Hashable)
   deriving (Show, Read, IsString) via (ViaIsScalar Char)
 
 instance Arbitrary Char where

src/library/PostgresqlTypes/Cidr.hs

@@ -16,6 +16,7 @@ where
 
 import qualified Data.Attoparsec.Text as Attoparsec
 import Data.Bits
+import Data.Hashable (Hashable (..))
 import PostgresqlTypes.Algebra
 import PostgresqlTypes.Prelude hiding (fold)
 import PostgresqlTypes.Via
@@ -82,6 +83,11 @@ instance Arbitrary Cidr where
         netmask' <= 128
       ]
 
+instance Hashable Cidr where
+  hashWithSalt salt = \case
+    V4Cidr addr netmask -> salt `hashWithSalt` (0 :: Int) `hashWithSalt` addr `hashWithSalt` netmask
+    V6Cidr w1 w2 w3 w4 netmask -> salt `hashWithSalt` (1 :: Int) `hashWithSalt` w1 `hashWithSalt` w2 `hashWithSalt` w3 `hashWithSalt` w4 `hashWithSalt` netmask
+
 instance IsScalar Cidr where
   schemaName = Tagged Nothing
   typeName = Tagged "cidr"

src/library/PostgresqlTypes/Circle.hs

@@ -13,6 +13,7 @@ module PostgresqlTypes.Circle
 where
 
 import qualified Data.Attoparsec.Text as Attoparsec
+import Data.Hashable (Hashable (..))
 import GHC.Float (castDoubleToWord64, castWord64ToDouble)
 import PostgresqlTypes.Algebra
 import PostgresqlTypes.Prelude
@@ -51,6 +52,12 @@ instance Arbitrary Circle where
     r' <- abs <$> shrink r
     pure (Circle x' y' r')
 
+instance Hashable Circle where
+  hashWithSalt salt (Circle x y r) =
+    salt `hashWithSalt` castDoubleToWord64 x
+      `hashWithSalt` castDoubleToWord64 y
+      `hashWithSalt` castDoubleToWord64 r
+
 instance IsScalar Circle where
   schemaName = Tagged Nothing
   typeName = Tagged "circle"

src/library/PostgresqlTypes/Date.hs

@@ -11,6 +11,7 @@ module PostgresqlTypes.Date
 where
 
 import qualified Data.Attoparsec.Text as Attoparsec
+import Data.Hashable (Hashable)
 import qualified Data.Time as Time
 import PostgresqlTypes.Algebra
 import PostgresqlTypes.Prelude
@@ -28,7 +29,7 @@ import qualified TextBuilder
 newtype Date
   = -- | Days since PostgreSQL epoch (2000-01-01).
     Date Int32
-  deriving newtype (Eq, Ord)
+  deriving newtype (Eq, Ord, Hashable)
   deriving (Show, Read, IsString) via (ViaIsScalar Date)
 
 -- | PostgreSQL date range: 4713 BC to 5874897 AD.