Safe Haskell	None
Language	Haskell2010

Data.LargeHashable.Class

Description

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

Synopsis

class LargeHashable a where
- updateHash :: a -> LH ()
- updateHashStable :: a -> LH ()
largeHash :: LargeHashable a => HashAlgorithm h -> a -> h
largeHashStable :: LargeHashable a => HashAlgorithm h -> a -> h
class LargeHashable' t where
- 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 ()

Documentation

class LargeHashable a where Source #

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

The laws of this typeclass are the following:

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.
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 () Source #

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

updateHashStable :: a -> LH () Source #

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

Instances

Instances details

LargeHashable Key Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Key -> LH () Source # updateHashStable :: Key -> LH () Source #
LargeHashable Value Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Value -> LH () Source # updateHashStable :: Value -> LH () Source #
LargeHashable CChar Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: CChar -> LH () Source # updateHashStable :: CChar -> LH () Source #
LargeHashable CInt Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: CInt -> LH () Source # updateHashStable :: CInt -> LH () Source #
LargeHashable CLong Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: CLong -> LH () Source # updateHashStable :: CLong -> LH () Source #
LargeHashable CShort Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: CShort -> LH () Source # updateHashStable :: CShort -> LH () Source #
LargeHashable CUChar Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: CUChar -> LH () Source # updateHashStable :: CUChar -> LH () Source #
LargeHashable CUInt Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: CUInt -> LH () Source # updateHashStable :: CUInt -> LH () Source #
LargeHashable CULong Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: CULong -> LH () Source # updateHashStable :: CULong -> LH () Source #
LargeHashable CUShort Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: CUShort -> LH () Source # updateHashStable :: CUShort -> LH () Source #
LargeHashable Void Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Void -> LH () Source # updateHashStable :: Void -> LH () Source #
LargeHashable Int16 Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Int16 -> LH () Source # updateHashStable :: Int16 -> LH () Source #
LargeHashable Int32 Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Int32 -> LH () Source # updateHashStable :: Int32 -> LH () Source #
LargeHashable Int64 Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Int64 -> LH () Source # updateHashStable :: Int64 -> LH () Source #
LargeHashable Int8 Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Int8 -> LH () Source # updateHashStable :: Int8 -> LH () Source #
LargeHashable Word16 Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Word16 -> LH () Source # updateHashStable :: Word16 -> LH () Source #
LargeHashable Word32 Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Word32 -> LH () Source # updateHashStable :: Word32 -> LH () Source #
LargeHashable Word64 Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Word64 -> LH () Source # updateHashStable :: Word64 -> LH () Source #
LargeHashable Word8 Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Word8 -> LH () Source # updateHashStable :: Word8 -> LH () Source #
LargeHashable ByteString Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: ByteString -> LH () Source # updateHashStable :: ByteString -> LH () Source #
LargeHashable ByteString Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: ByteString -> LH () Source # updateHashStable :: ByteString -> LH () Source #
LargeHashable ShortByteString Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: ShortByteString -> LH () Source # updateHashStable :: ShortByteString -> LH () Source #
LargeHashable IntSet Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: IntSet -> LH () Source # updateHashStable :: IntSet -> LH () Source #
LargeHashable Ordering Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Ordering -> LH () Source # updateHashStable :: Ordering -> LH () Source #
LargeHashable Scientific Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Scientific -> LH () Source # updateHashStable :: Scientific -> LH () Source #
LargeHashable Text Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Text -> LH () Source # updateHashStable :: Text -> LH () Source #
LargeHashable Text Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Text -> LH () Source # updateHashStable :: Text -> LH () Source #
LargeHashable Day Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Day -> LH () Source # updateHashStable :: Day -> LH () Source #
LargeHashable AbsoluteTime Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: AbsoluteTime -> LH () Source # updateHashStable :: AbsoluteTime -> LH () Source #
LargeHashable DiffTime Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: DiffTime -> LH () Source # updateHashStable :: DiffTime -> LH () Source #
LargeHashable NominalDiffTime Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: NominalDiffTime -> LH () Source # updateHashStable :: NominalDiffTime -> LH () Source #
LargeHashable UTCTime Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: UTCTime -> LH () Source # updateHashStable :: UTCTime -> LH () Source #
LargeHashable UniversalTime Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: UniversalTime -> LH () Source # updateHashStable :: UniversalTime -> LH () Source #
LargeHashable LocalTime Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: LocalTime -> LH () Source # updateHashStable :: LocalTime -> LH () Source #
LargeHashable TimeOfDay Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: TimeOfDay -> LH () Source # updateHashStable :: TimeOfDay -> LH () Source #
LargeHashable TimeZone Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: TimeZone -> LH () Source # updateHashStable :: TimeZone -> LH () Source #
LargeHashable ZonedTime Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: ZonedTime -> LH () Source # updateHashStable :: ZonedTime -> LH () Source #
LargeHashable Integer Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Integer -> LH () Source # updateHashStable :: Integer -> LH () Source #
LargeHashable () Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: () -> LH () Source # updateHashStable :: () -> LH () Source #
LargeHashable Bool Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Bool -> LH () Source # updateHashStable :: Bool -> LH () Source #
LargeHashable Char Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Char -> LH () Source # updateHashStable :: Char -> LH () Source #
LargeHashable Double Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Double -> LH () Source # updateHashStable :: Double -> LH () Source #
LargeHashable Float Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Float -> LH () Source # updateHashStable :: Float -> LH () Source #
LargeHashable Int Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Int -> LH () Source # updateHashStable :: Int -> LH () Source #
LargeHashable Word Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Word -> LH () Source # updateHashStable :: Word -> LH () Source #
LargeHashable v => LargeHashable (KeyMap v) Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: KeyMap v -> LH () Source # updateHashStable :: KeyMap v -> LH () Source #
(Integral a, LargeHashable a) => LargeHashable (Ratio a) Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Ratio a -> LH () Source # updateHashStable :: Ratio a -> LH () Source #
LargeHashable a => LargeHashable (IntMap a) Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: IntMap a -> LH () Source # updateHashStable :: IntMap a -> LH () Source #
LargeHashable a => LargeHashable (Seq a) Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Seq a -> LH () Source # updateHashStable :: Seq a -> LH () Source #
LargeHashable a => LargeHashable (Set a) Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Set a -> LH () Source # updateHashStable :: Set a -> LH () Source #
LargeHashable a => LargeHashable (HashSet a) Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: HashSet a -> LH () Source # updateHashStable :: HashSet a -> LH () Source #
LargeHashable a => LargeHashable (Vector a) Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Vector a -> LH () Source # updateHashStable :: Vector a -> LH () Source #
LargeHashable a => LargeHashable (Maybe a) Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Maybe a -> LH () Source # updateHashStable :: Maybe a -> LH () Source #
LargeHashable a => LargeHashable [a] Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: [a] -> LH () Source # updateHashStable :: [a] -> LH () Source #
(LargeHashable a, LargeHashable b) => LargeHashable (Either a b) Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Either a b -> LH () Source # updateHashStable :: Either a b -> LH () Source #
HasResolution a => LargeHashable (Fixed a) Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Fixed a -> LH () Source # updateHashStable :: Fixed a -> LH () Source #
(LargeHashable k, LargeHashable a) => LargeHashable (Map k a) Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Map k a -> LH () Source # updateHashStable :: Map k a -> LH () Source #
(LargeHashable a, LargeHashable b) => LargeHashable (Pair a b) Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: Pair a b -> LH () Source # updateHashStable :: Pair a b -> LH () Source #
(LargeHashable k, LargeHashable v) => LargeHashable (HashMap k v) Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: HashMap k v -> LH () Source # updateHashStable :: HashMap k v -> LH () Source #
(LargeHashable a, LargeHashable b) => LargeHashable (a, b) Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: (a, b) -> LH () Source # updateHashStable :: (a, b) -> LH () Source #
(LargeHashable a, LargeHashable b, LargeHashable c) => LargeHashable (a, b, c) Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: (a, b, c) -> LH () Source # updateHashStable :: (a, b, c) -> LH () Source #
(LargeHashable a, LargeHashable b, LargeHashable c, LargeHashable d) => LargeHashable (a, b, c, d) Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: (a, b, c, d) -> LH () Source # updateHashStable :: (a, b, c, d) -> LH () Source #
(LargeHashable a, LargeHashable b, LargeHashable c, LargeHashable d, LargeHashable e) => LargeHashable (a, b, c, d, e) Source #
Instance details Defined in Data.LargeHashable.Class Methods updateHash :: (a, b, c, d, e) -> LH () Source # updateHashStable :: (a, b, c, d, e) -> LH () Source #

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

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 Source #

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 Source #

Methods

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

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

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

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