Data.LargeHashable.Class

This module defines the central type class LargeHashable of this package.

Documentation

class LargeHashable a where

A type class for computing hashes (i.e. MD5, SHA256, ...) from haskell values.

The laws of this typeclass are the following:

1. If two values are equal according to ==, then the finally computed hashes must also be equal according to ==. However it is not required that the hashes of inequal values have to be inequal. Also note that an instance of LargeHashable does not require a instance of Eq. Using any sane algorithm the chance of a collision should be 1 / n where n is the number of different hashes possible.
2. If two values are inequal according to ==, then the probability of a hash collision is 1/n, where n is the number of possible hashes produced by the underlying hash algorithm.

A rule of thumb: hash all information that you would also need for serializing/deserializing values of your datatype. For instance, when hashing lists, you would not only hash the list elements but also the length of the list. Consider the following datatype

data Foo = Foo [Int] [Int]

We now write an instance for LargeHashable like this

instance LargeHashable Foo where
    updateHash (Foo l1 l2) = updateHash l1 >> updateHash l2

If we did not hash the length of a list, then the following two values of Foo would produce identical hashes:

Foo [1,2,3] []
Foo [1] [2,3]

Minimal complete definition

Nothing

Methods

updateHash :: a -> LH ()

default updateHash :: (GenericLargeHashable (Rep a), Generic a) => a -> LH ()

updateHashStable :: a -> LH ()

default updateHashStable :: (GenericLargeHashable (Rep a), Generic a) => a -> LH ()

Instances

LargeHashable Key

Defined in Data.LargeHashable.Class

Methods

updateHash :: Key -> LH ()

updateHashStable :: Key -> LH ()

LargeHashable Value

Defined in Data.LargeHashable.Class

Methods

updateHash :: Value -> LH ()

updateHashStable :: Value -> LH ()

LargeHashable CChar

Defined in Data.LargeHashable.Class

Methods

updateHash :: CChar -> LH ()

updateHashStable :: CChar -> LH ()

LargeHashable CInt

Defined in Data.LargeHashable.Class

Methods

updateHash :: CInt -> LH ()

updateHashStable :: CInt -> LH ()

LargeHashable CLong

Defined in Data.LargeHashable.Class

Methods

updateHash :: CLong -> LH ()

updateHashStable :: CLong -> LH ()

LargeHashable CShort

Defined in Data.LargeHashable.Class

Methods

updateHash :: CShort -> LH ()

updateHashStable :: CShort -> LH ()

LargeHashable CUChar

Defined in Data.LargeHashable.Class

Methods

updateHash :: CUChar -> LH ()

updateHashStable :: CUChar -> LH ()

LargeHashable CUInt

Defined in Data.LargeHashable.Class

Methods

updateHash :: CUInt -> LH ()

updateHashStable :: CUInt -> LH ()

LargeHashable CULong

Defined in Data.LargeHashable.Class

Methods

updateHash :: CULong -> LH ()

updateHashStable :: CULong -> LH ()

LargeHashable CUShort

Defined in Data.LargeHashable.Class

Methods

updateHash :: CUShort -> LH ()

updateHashStable :: CUShort -> LH ()

LargeHashable Void

Defined in Data.LargeHashable.Class

Methods

updateHash :: Void -> LH ()

updateHashStable :: Void -> LH ()

LargeHashable Int16

Defined in Data.LargeHashable.Class

Methods

updateHash :: Int16 -> LH ()

updateHashStable :: Int16 -> LH ()

LargeHashable Int32

Defined in Data.LargeHashable.Class

Methods

updateHash :: Int32 -> LH ()

updateHashStable :: Int32 -> LH ()

LargeHashable Int64

Defined in Data.LargeHashable.Class

Methods

updateHash :: Int64 -> LH ()

updateHashStable :: Int64 -> LH ()

LargeHashable Int8

Defined in Data.LargeHashable.Class

Methods

updateHash :: Int8 -> LH ()

updateHashStable :: Int8 -> LH ()

LargeHashable Word16

Defined in Data.LargeHashable.Class

Methods

updateHash :: Word16 -> LH ()

updateHashStable :: Word16 -> LH ()

LargeHashable Word32

Defined in Data.LargeHashable.Class

Methods

updateHash :: Word32 -> LH ()

updateHashStable :: Word32 -> LH ()

LargeHashable Word64

Defined in Data.LargeHashable.Class

Methods

updateHash :: Word64 -> LH ()

updateHashStable :: Word64 -> LH ()

LargeHashable Word8

Defined in Data.LargeHashable.Class

Methods

updateHash :: Word8 -> LH ()

updateHashStable :: Word8 -> LH ()

LargeHashable ByteString

Defined in Data.LargeHashable.Class

Methods

updateHash :: ByteString -> LH ()

updateHashStable :: ByteString -> LH ()

LargeHashable ByteString

Defined in Data.LargeHashable.Class

Methods

updateHash :: ByteString -> LH ()

updateHashStable :: ByteString -> LH ()

LargeHashable ShortByteString

Defined in Data.LargeHashable.Class

Methods

updateHash :: ShortByteString -> LH ()

updateHashStable :: ShortByteString -> LH ()

LargeHashable IntSet

Defined in Data.LargeHashable.Class

Methods

updateHash :: IntSet -> LH ()

updateHashStable :: IntSet -> LH ()

LargeHashable Ordering

Defined in Data.LargeHashable.Class

Methods

updateHash :: Ordering -> LH ()

updateHashStable :: Ordering -> LH ()

LargeHashable Scientific

Defined in Data.LargeHashable.Class

Methods

updateHash :: Scientific -> LH ()

updateHashStable :: Scientific -> LH ()

LargeHashable Text

Defined in Data.LargeHashable.Class

Methods

updateHash :: Text -> LH ()

updateHashStable :: Text -> LH ()

LargeHashable Text

Defined in Data.LargeHashable.Class

Methods

updateHash :: Text -> LH ()

updateHashStable :: Text -> LH ()

LargeHashable Day

Defined in Data.LargeHashable.Class

Methods

updateHash :: Day -> LH ()

updateHashStable :: Day -> LH ()

LargeHashable AbsoluteTime

Defined in Data.LargeHashable.Class

Methods

updateHash :: AbsoluteTime -> LH ()

updateHashStable :: AbsoluteTime -> LH ()

LargeHashable DiffTime

Defined in Data.LargeHashable.Class

Methods

updateHash :: DiffTime -> LH ()

updateHashStable :: DiffTime -> LH ()

LargeHashable NominalDiffTime

Defined in Data.LargeHashable.Class

Methods

updateHash :: NominalDiffTime -> LH ()

updateHashStable :: NominalDiffTime -> LH ()

LargeHashable UTCTime

Defined in Data.LargeHashable.Class

Methods

updateHash :: UTCTime -> LH ()

updateHashStable :: UTCTime -> LH ()

LargeHashable UniversalTime

Defined in Data.LargeHashable.Class

Methods

updateHash :: UniversalTime -> LH ()

updateHashStable :: UniversalTime -> LH ()

LargeHashable LocalTime

Defined in Data.LargeHashable.Class

Methods

updateHash :: LocalTime -> LH ()

updateHashStable :: LocalTime -> LH ()

LargeHashable TimeOfDay

Defined in Data.LargeHashable.Class

Methods

updateHash :: TimeOfDay -> LH ()

updateHashStable :: TimeOfDay -> LH ()

LargeHashable TimeZone

Defined in Data.LargeHashable.Class

Methods

updateHash :: TimeZone -> LH ()

updateHashStable :: TimeZone -> LH ()

LargeHashable ZonedTime

Defined in Data.LargeHashable.Class

Methods

updateHash :: ZonedTime -> LH ()

updateHashStable :: ZonedTime -> LH ()

LargeHashable Integer

Defined in Data.LargeHashable.Class

Methods

updateHash :: Integer -> LH ()

updateHashStable :: Integer -> LH ()

LargeHashable ()

Defined in Data.LargeHashable.Class

Methods

updateHash :: () -> LH ()

updateHashStable :: () -> LH ()

LargeHashable Bool

Defined in Data.LargeHashable.Class

Methods

updateHash :: Bool -> LH ()

updateHashStable :: Bool -> LH ()

LargeHashable Char

Defined in Data.LargeHashable.Class

Methods

updateHash :: Char -> LH ()

updateHashStable :: Char -> LH ()

LargeHashable Double

Defined in Data.LargeHashable.Class

Methods

updateHash :: Double -> LH ()

updateHashStable :: Double -> LH ()

LargeHashable Float

Defined in Data.LargeHashable.Class

Methods

updateHash :: Float -> LH ()

updateHashStable :: Float -> LH ()

LargeHashable Int

Defined in Data.LargeHashable.Class

Methods

updateHash :: Int -> LH ()

updateHashStable :: Int -> LH ()

LargeHashable Word

Defined in Data.LargeHashable.Class

Methods

updateHash :: Word -> LH ()

updateHashStable :: Word -> LH ()

LargeHashable v => LargeHashable (KeyMap v)

Defined in Data.LargeHashable.Class

Methods

updateHash :: KeyMap v -> LH ()

updateHashStable :: KeyMap v -> LH ()

(Integral a, LargeHashable a) => LargeHashable (Ratio a)

Defined in Data.LargeHashable.Class

Methods

updateHash :: Ratio a -> LH ()

updateHashStable :: Ratio a -> LH ()

LargeHashable a => LargeHashable (IntMap a)

Defined in Data.LargeHashable.Class

Methods

updateHash :: IntMap a -> LH ()

updateHashStable :: IntMap a -> LH ()

LargeHashable a => LargeHashable (Seq a)

Defined in Data.LargeHashable.Class

Methods

updateHash :: Seq a -> LH ()

updateHashStable :: Seq a -> LH ()

LargeHashable a => LargeHashable (Set a)

Defined in Data.LargeHashable.Class

Methods

updateHash :: Set a -> LH ()

updateHashStable :: Set a -> LH ()

LargeHashable a => LargeHashable (HashSet a)

Defined in Data.LargeHashable.Class

Methods

updateHash :: HashSet a -> LH ()

updateHashStable :: HashSet a -> LH ()

LargeHashable a => LargeHashable (Vector a)

Defined in Data.LargeHashable.Class

Methods

updateHash :: Vector a -> LH ()

updateHashStable :: Vector a -> LH ()

LargeHashable a => LargeHashable (Maybe a)

Defined in Data.LargeHashable.Class

Methods

updateHash :: Maybe a -> LH ()

updateHashStable :: Maybe a -> LH ()

LargeHashable a => LargeHashable [a]

Defined in Data.LargeHashable.Class

Methods

updateHash :: [a] -> LH ()

updateHashStable :: [a] -> LH ()

(LargeHashable a, LargeHashable b) => LargeHashable (Either a b)

Defined in Data.LargeHashable.Class

Methods

updateHash :: Either a b -> LH ()

updateHashStable :: Either a b -> LH ()

HasResolution a => LargeHashable (Fixed a)

Defined in Data.LargeHashable.Class

Methods

updateHash :: Fixed a -> LH ()

updateHashStable :: Fixed a -> LH ()

(LargeHashable k, LargeHashable a) => LargeHashable (Map k a)

Defined in Data.LargeHashable.Class

Methods

updateHash :: Map k a -> LH ()

updateHashStable :: Map k a -> LH ()

(LargeHashable a, LargeHashable b) => LargeHashable (Pair a b)

Defined in Data.LargeHashable.Class

Methods

updateHash :: Pair a b -> LH ()

updateHashStable :: Pair a b -> LH ()

(LargeHashable k, LargeHashable v) => LargeHashable (HashMap k v)

Defined in Data.LargeHashable.Class

Methods

updateHash :: HashMap k v -> LH ()

updateHashStable :: HashMap k v -> LH ()

(LargeHashable a, LargeHashable b) => LargeHashable (a, b)

Defined in Data.LargeHashable.Class

Methods

updateHash :: (a, b) -> LH ()

updateHashStable :: (a, b) -> LH ()

(LargeHashable a, LargeHashable b, LargeHashable c) => LargeHashable (a, b, c)

Defined in Data.LargeHashable.Class

Methods

updateHash :: (a, b, c) -> LH ()

updateHashStable :: (a, b, c) -> LH ()

(LargeHashable a, LargeHashable b, LargeHashable c, LargeHashable d) => LargeHashable (a, b, c, d)

Defined in Data.LargeHashable.Class

Methods

updateHash :: (a, b, c, d) -> LH ()

updateHashStable :: (a, b, c, d) -> LH ()

(LargeHashable a, LargeHashable b, LargeHashable c, LargeHashable d, LargeHashable e) => LargeHashable (a, b, c, d, e)

Defined in Data.LargeHashable.Class

Methods

updateHash :: (a, b, c, d, e) -> LH ()

updateHashStable :: (a, b, c, d, e) -> LH ()

largeHash :: LargeHashable a => HashAlgorithm h -> a -> h

largeHash is the central function of this package. For a given value it computes a Hash using the given HashAlgorithm. The library tries to keep the hash values for LargeHashable instances provided by library stable across releases, but there is no guarantee. See @largeHashStable&

largeHashStable :: LargeHashable a => HashAlgorithm h -> a -> h

largeHashStable is similar to largeHash, but the hash value is guaranteed to remain stable across releases, even if this causes performance to degrade.

class LargeHashable' t where

Methods

updateHash' :: LargeHashable a => t a -> LH ()

updateHashStable' :: LargeHashable a => t a -> LH ()

genericUpdateHash :: (Generic a, GenericLargeHashable (Rep a)) => a -> LH ()

updateHashList :: forall a. (a -> LH ()) -> [a] -> LH ()