Data.Multihash

multihash encoding of Digests.

Example:

>>> :set -XOverloadedStrings
>>> import qualified Crypto.Hash as C
>>> import Data.ByteArray.Encoding (Base(..), convertToBase)
>>> import Data.ByteString (ByteString)
>>> import qualified Data.ByteString.Char8 as C8
>>> import System.IO (stdout)
>>> :{
    let
        input :: ByteString
        input = "multihash"
        atBase :: Base -> Multihash -> ByteString
        atBase base = convertToBase base . encodedBytes
     in
        C8.hPutStr stdout $ C8.unlines
            [ atBase Base16 $ multihash C.SHA1   input
            , atBase Base32 $ multihash C.SHA1   input
            , atBase Base16 $ multihash C.SHA256 input
            , atBase Base32 $ multihash C.SHA256 input
            ]
:}
111488c2f11fb2ce392acb5b2986e640211c4690073e
CEKIRQXRD6ZM4OJKZNNSTBXGIAQRYRUQA47A====
12209cbc07c3f991725836a3aa2a581ca2029198aa420b9d99bc0e131d9f3e2cbe47
CIQJZPAHYP4ZC4SYG2R2UKSYDSRAFEMYVJBAXHMZXQHBGHM7HYWL4RY=

Documentation

data Multihash

A multihash-encoded strict ByteString.

Instances

Eq Multihash

Defined in Data.Multihash

Methods

(==) :: Multihash -> Multihash -> Bool

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

Ord Multihash

Defined in Data.Multihash

Methods

compare :: Multihash -> Multihash -> Ordering

(<) :: Multihash -> Multihash -> Bool

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

(>) :: Multihash -> Multihash -> Bool

(>=) :: Multihash -> Multihash -> Bool

max :: Multihash -> Multihash -> Multihash

min :: Multihash -> Multihash -> Multihash

NFData Multihash

Defined in Data.Multihash

Methods

rnf :: Multihash -> ()

Hashable Multihash

Defined in Data.Multihash

Methods

hashWithSalt :: Int -> Multihash -> Int

hash :: Multihash -> Int

fromDigest :: forall a. Multihashable a => Digest a -> Multihash

Encode a Digest as a Multihash.

encodedBytes :: Multihash -> ByteString

Extract the raw, multihash-encoded bytes of a Multihash.

multihash :: (ByteArrayAccess ba, Multihashable a) => a -> ba -> Multihash

Hash a value to a Multihash

decode :: ByteString -> Either String Multihash

Decode a Multihash from a ByteString.

decodeDigest :: forall a. Multihashable a => ByteString -> Either String (Digest a)

Decode a Digest from a multihash-encoded ByteString.

getMultihash :: Get Multihash

Compact representation

data CompactMultihash

A Multihash backed by a ShortByteString.

This is useful when holding many Multihashes in memory, due to lower memory overhead and less heap fragmentation. See the documentation for ShortByteString for details.

Instances

Eq CompactMultihash

Defined in Data.Multihash

Methods

(==) :: CompactMultihash -> CompactMultihash -> Bool

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

Ord CompactMultihash

Defined in Data.Multihash

Methods

compare :: CompactMultihash -> CompactMultihash -> Ordering

(<) :: CompactMultihash -> CompactMultihash -> Bool

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

(>) :: CompactMultihash -> CompactMultihash -> Bool

(>=) :: CompactMultihash -> CompactMultihash -> Bool

max :: CompactMultihash -> CompactMultihash -> CompactMultihash

min :: CompactMultihash -> CompactMultihash -> CompactMultihash

NFData CompactMultihash

Defined in Data.Multihash

Methods

rnf :: CompactMultihash -> ()

Hashable CompactMultihash

Defined in Data.Multihash

Methods

hashWithSalt :: Int -> CompactMultihash -> Int

hash :: CompactMultihash -> Int

compact :: Multihash -> CompactMultihash

Convert a Multihash to a compact representation.

expand :: CompactMultihash -> Multihash

Convert a CompactMultihash to the regular representation.

Re-exports

data HashAlgorithm

HashAlgorithms for which we know a multihash code.

Note that this currently excludes variable output-length algorithms.

Instances

Bounded HashAlgorithm

Defined in Data.Multihash.Internal

Methods

minBound :: HashAlgorithm

maxBound :: HashAlgorithm

Enum HashAlgorithm

Defined in Data.Multihash.Internal

Methods

succ :: HashAlgorithm -> HashAlgorithm

pred :: HashAlgorithm -> HashAlgorithm

toEnum :: Int -> HashAlgorithm

fromEnum :: HashAlgorithm -> Int

enumFrom :: HashAlgorithm -> [HashAlgorithm]

enumFromThen :: HashAlgorithm -> HashAlgorithm -> [HashAlgorithm]

enumFromTo :: HashAlgorithm -> HashAlgorithm -> [HashAlgorithm]

enumFromThenTo :: HashAlgorithm -> HashAlgorithm -> HashAlgorithm -> [HashAlgorithm]

Eq HashAlgorithm

Defined in Data.Multihash.Internal

Methods

(==) :: HashAlgorithm -> HashAlgorithm -> Bool

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

type Multihashable a = (HashAlgorithm a, FromCryptonite a)

fromCryptonite :: FromCryptonite a => proxy a -> HashAlgorithm

toCode :: HashAlgorithm -> Word16

fromCode :: Word16 -> Maybe HashAlgorithm

digestSize :: HashAlgorithm -> Int