Sel.Hashing.Short

Introduction

This module provides an API for performant short-input hashing, backed by the SipHash-2-4 algorithm.

Short-input hashing functions have a variety of use-cases, such as:

• Hash Tables
• Probabilistic data structures, such as Bloom filters
• Integrity checking in interactive protocols

data ShortHash

A 128-bit hash of a short input, of size cryptoShortHashSipHashX24Bytes

Since: 0.0.1.0

Instances

Show ShortHash

Since: 0.0.1.0

Defined in Sel.Hashing.Short

Methods

showsPrec :: Int -> ShortHash -> ShowS

show :: ShortHash -> String

showList :: [ShortHash] -> ShowS

Eq ShortHash

Since: 0.0.1.0

Defined in Sel.Hashing.Short

Methods

(==) :: ShortHash -> ShortHash -> Bool

(/=) :: ShortHash -> ShortHash -> Bool

Ord ShortHash

Since: 0.0.1.0

Defined in Sel.Hashing.Short

Methods

compare :: ShortHash -> ShortHash -> Ordering

(<) :: ShortHash -> ShortHash -> Bool

(<=) :: ShortHash -> ShortHash -> Bool

(>) :: ShortHash -> ShortHash -> Bool

(>=) :: ShortHash -> ShortHash -> Bool

max :: ShortHash -> ShortHash -> ShortHash

min :: ShortHash -> ShortHash -> ShortHash

Display ShortHash

Since: 0.0.1.0

Defined in Sel.Hashing.Short

Methods

displayBuilder :: ShortHash -> Builder

displayList :: [ShortHash] -> Builder

displayPrec :: Int -> ShortHash -> Builder

Short-input Hashing

hashByteString

Arguments

:: ShortHashKey

Random key produced by newKey

-> StrictByteString

Data to hash

-> IO ShortHash

Hash a StrictByteString.

The same message hashed with the same key will always produce the same output.

The ShortHash is of length cryptoShortHashSipHashX24Bytes

Since: 0.0.1.0

hashText

Arguments

:: ShortHashKey

Random key produced by newKey

-> Text

UTF-8 encoded data to hash

-> IO ShortHash

Hash a strict Text.

The same message hashed with the same key will always produce the same output.

The ShortHash is of length cryptoShortHashSipHashX24Bytes

Since: 0.0.1.0

Conversion

shortHashToBinary :: ShortHash -> StrictByteString

Convert a ShortHash to a strict binary StrictByteString.

Since: 0.0.1.0

shortHashToHexText :: ShortHash -> Text

Convert a ShortHash to a strict hexadecimal-encoded Text.

Since: 0.0.1.0

shortHashToHexByteString :: ShortHash -> StrictByteString

Convert a ShortHash to a hexadecimal-encoded StrictByteString.

Since: 0.0.1.0

Short Hash Key

data ShortHashKey

A random key used for hashing, of size cryptoShortHashSipHashX24KeyBytes.

The same message hashed with the same key will always produce the same output.

Since: 0.0.1.0

Instances

Show ShortHashKey

Since: 0.0.1.0

Defined in Sel.Hashing.Short

Methods

showsPrec :: Int -> ShortHashKey -> ShowS

show :: ShortHashKey -> String

showList :: [ShortHashKey] -> ShowS

Eq ShortHashKey

Since: 0.0.1.0

Defined in Sel.Hashing.Short

Methods

(==) :: ShortHashKey -> ShortHashKey -> Bool

(/=) :: ShortHashKey -> ShortHashKey -> Bool

Ord ShortHashKey

Since: 0.0.1.0

Defined in Sel.Hashing.Short

Methods

compare :: ShortHashKey -> ShortHashKey -> Ordering

(<) :: ShortHashKey -> ShortHashKey -> Bool

(<=) :: ShortHashKey -> ShortHashKey -> Bool

(>) :: ShortHashKey -> ShortHashKey -> Bool

(>=) :: ShortHashKey -> ShortHashKey -> Bool

max :: ShortHashKey -> ShortHashKey -> ShortHashKey

min :: ShortHashKey -> ShortHashKey -> ShortHashKey

Display ShortHashKey

Defined in Sel.Hashing.Short

Methods

displayBuilder :: ShortHashKey -> Builder

displayList :: [ShortHashKey] -> Builder

displayPrec :: Int -> ShortHashKey -> Builder

newKey :: IO ShortHashKey

Generate a random ShortHashKey of size cryptoShortHashSipHashX24KeyBytes

Since: 0.0.1.0

Conversion

shortHashKeyToBinary :: ShortHashKey -> StrictByteString

Convert a ShortHash to a strict binary StrictByteString.

Since: 0.0.1.0

shortHashKeyToHexText :: ShortHashKey -> Text

Convert a ShortHash to a strict hexadecimal-encoded Text.

Since: 0.0.1.0

shortHashKeyToHexByteString :: ShortHashKey -> StrictByteString

Convert a ShortHash to a hexadecimal-encoded StrictByteString.

Since: 0.0.1.0

binaryToShortHashKey :: StrictByteString -> Maybe ShortHashKey

Convert a binary StrictByteString to a ShortHashKey.

The input key must be of length cryptoShortHashSipHashX24KeyBytes

Since: 0.0.1.0

hexTextToShortHashKey :: Text -> Maybe ShortHashKey

Convert a strict hexadecimal-encoded Text to a ShortHashKey.

The input key, once decoded from base16, must be of length cryptoShortHashSipHashX24KeyBytes

Since: 0.0.1.0

hexByteStringToShortHashKey :: StrictByteString -> Maybe ShortHashKey

Convert a hexadecimal-encoded StrictByteString to a ShortHashKey.

The input key, once decoded from base16, must be of length cryptoShortHashSipHashX24KeyBytes

Since: 0.0.1.0

Errors

data ShortHashingException

Exception thrown upon error during hashing by hashByteString or hashText.

Since: 0.0.1.0

Constructors

ShortHashingException

Instances

Exception ShortHashingException

Since: 0.0.1.0

Defined in Sel.Hashing.Short

Methods

toException :: ShortHashingException -> SomeException

fromException :: SomeException -> Maybe ShortHashingException

displayException :: ShortHashingException -> String

Show ShortHashingException

Since: 0.0.1.0

Defined in Sel.Hashing.Short

Methods

showsPrec :: Int -> ShortHashingException -> ShowS

show :: ShortHashingException -> String

showList :: [ShortHashingException] -> ShowS

Eq ShortHashingException

Since: 0.0.1.0

Defined in Sel.Hashing.Short

Methods

(==) :: ShortHashingException -> ShortHashingException -> Bool

(/=) :: ShortHashingException -> ShortHashingException -> Bool

Ord ShortHashingException

Since: 0.0.1.0

Defined in Sel.Hashing.Short

Methods

compare :: ShortHashingException -> ShortHashingException -> Ordering

(<) :: ShortHashingException -> ShortHashingException -> Bool

(<=) :: ShortHashingException -> ShortHashingException -> Bool

(>) :: ShortHashingException -> ShortHashingException -> Bool

(>=) :: ShortHashingException -> ShortHashingException -> Bool

max :: ShortHashingException -> ShortHashingException -> ShortHashingException

min :: ShortHashingException -> ShortHashingException -> ShortHashingException

Display ShortHashingException

Since: 0.0.1.0

Defined in Sel.Hashing.Short

Methods

displayBuilder :: ShortHashingException -> Builder

displayList :: [ShortHashingException] -> Builder

displayPrec :: Int -> ShortHashingException -> Builder