Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Crypto.Hash.Class

Contents

Core operations
Conversions
Rendering and parsing
Other operations
Deprecated

Description

Abstract hashing functionality.

Synopsis

class (KnownNat (SizeHash h), Typeable h) ⇒ HashAlgorithm h where
- type SizeHash h ∷ Nat
- hashAlgorithmName ∷ proxy h → String
- digest ∷ proxy h → ByteString → ByteString
sizeHash ∷ ∀ h proxy. HashAlgorithm h ⇒ proxy h → Word
data ByteString
data Hash h a where
- pattern UnsafeHash ∷ ∀ h a. HashAlgorithm h ⇒ ShortByteString → Hash h a
data PackedBytes (n ∷ Nat) where
- PackedBytes8 ∷ !Word64 → PackedBytes 8
- PackedBytes28 ∷ !Word64 → !Word64 → !Word64 → !Word32 → PackedBytes 28
- PackedBytes32 ∷ !Word64 → !Word64 → !Word64 → !Word64 → PackedBytes 32
hashWith ∷ ∀ h a. HashAlgorithm h ⇒ (a → ByteString) → a → Hash h a
hashWithSerialiser ∷ ∀ h a. HashAlgorithm h ⇒ (a → Encoding) → a → Hash h a
castHash ∷ Hash h a → Hash h b
hashToBytes ∷ Hash h a → ByteString
hashFromBytes ∷ ∀ h a. HashAlgorithm h ⇒ ByteString → Maybe (Hash h a)
hashToBytesShort ∷ Hash h a → ShortByteString
hashFromBytesShort ∷ ∀ h a. HashAlgorithm h ⇒ ShortByteString → Maybe (Hash h a)
hashFromOffsetBytesShort ∷ ∀ h a. HashAlgorithm h ⇒ ShortByteString → Int → Maybe (Hash h a)
hashToPackedBytes ∷ Hash h a → PackedBytes (SizeHash h)
hashFromPackedBytes ∷ PackedBytes (SizeHash h) → Hash h a
hashToBytesAsHex ∷ Hash h a → ByteString
hashFromBytesAsHex ∷ HashAlgorithm h ⇒ ByteString → Maybe (Hash h a)
hashToTextAsHex ∷ Hash h a → Text
hashFromTextAsHex ∷ HashAlgorithm h ⇒ Text → Maybe (Hash h a)
hashToStringAsHex ∷ Hash h a → String
hashFromStringAsHex ∷ HashAlgorithm h ⇒ String → Maybe (Hash h a)
xor ∷ Hash h a → Hash h a → Hash h a
hash ∷ ∀ h a. (HashAlgorithm h, ToCBOR a) ⇒ a → Hash h a
fromHash ∷ Hash h a → Natural
hashRaw ∷ ∀ h a. HashAlgorithm h ⇒ (a → ByteString) → a → Hash h a
getHash ∷ Hash h a → ByteString
getHashBytesAsHex ∷ Hash h a → ByteString

Documentation

class (KnownNat (SizeHash h), Typeable h) ⇒ HashAlgorithm h where Source #

Associated Types

type SizeHash h ∷ Nat Source #

Size of hash digest

Methods

hashAlgorithmName ∷ proxy h → String Source #

digest ∷ proxy h → ByteString → ByteString Source #

Instances

Instances details

HashAlgorithm Blake2b_224 Source #
Instance details Defined in Cardano.Crypto.Hash.Blake2b Associated Types type SizeHash Blake2b_224 ∷ Nat Source # Methods hashAlgorithmName ∷ proxy Blake2b_224 → String Source # digest ∷ proxy Blake2b_224 → ByteString → ByteString Source #
HashAlgorithm Blake2b_256 Source #
Instance details Defined in Cardano.Crypto.Hash.Blake2b Associated Types type SizeHash Blake2b_256 ∷ Nat Source # Methods hashAlgorithmName ∷ proxy Blake2b_256 → String Source # digest ∷ proxy Blake2b_256 → ByteString → ByteString Source #
HashAlgorithm Keccak256 Source #
Instance details Defined in Cardano.Crypto.Hash.Keccak256 Associated Types type SizeHash Keccak256 ∷ Nat Source # Methods hashAlgorithmName ∷ proxy Keccak256 → String Source # digest ∷ proxy Keccak256 → ByteString → ByteString Source #
HashAlgorithm NeverHash Source #
Instance details Defined in Cardano.Crypto.Hash.NeverUsed Associated Types type SizeHash NeverHash ∷ Nat Source # Methods hashAlgorithmName ∷ proxy NeverHash → String Source # digest ∷ proxy NeverHash → ByteString → ByteString Source #
HashAlgorithm RIPEMD160 Source #
Instance details Defined in Cardano.Crypto.Hash.RIPEMD160 Associated Types type SizeHash RIPEMD160 ∷ Nat Source # Methods hashAlgorithmName ∷ proxy RIPEMD160 → String Source # digest ∷ proxy RIPEMD160 → ByteString → ByteString Source #
HashAlgorithm SHA256 Source #
Instance details Defined in Cardano.Crypto.Hash.SHA256 Associated Types type SizeHash SHA256 ∷ Nat Source # Methods hashAlgorithmName ∷ proxy SHA256 → String Source # digest ∷ proxy SHA256 → ByteString → ByteString Source #
HashAlgorithm SHA3_256 Source #
Instance details Defined in Cardano.Crypto.Hash.SHA3_256 Associated Types type SizeHash SHA3_256 ∷ Nat Source # Methods hashAlgorithmName ∷ proxy SHA3_256 → String Source # digest ∷ proxy SHA3_256 → ByteString → ByteString Source #
HashAlgorithm SHA3_512 Source #
Instance details Defined in Cardano.Crypto.Hash.SHA3_512 Associated Types type SizeHash SHA3_512 ∷ Nat Source # Methods hashAlgorithmName ∷ proxy SHA3_512 → String Source # digest ∷ proxy SHA3_512 → ByteString → ByteString Source #
HashAlgorithm SHA512 Source #
Instance details Defined in Cardano.Crypto.Hash.SHA512 Associated Types type SizeHash SHA512 ∷ Nat Source # Methods hashAlgorithmName ∷ proxy SHA512 → String Source # digest ∷ proxy SHA512 → ByteString → ByteString Source #
(KnownNat n, CmpNat n 33 ~ 'LT) ⇒ HashAlgorithm (Blake2bPrefix n) Source #
Instance details Defined in Cardano.Crypto.Hash.Short Associated Types type SizeHash (Blake2bPrefix n) ∷ Nat Source # Methods hashAlgorithmName ∷ proxy (Blake2bPrefix n) → String Source # digest ∷ proxy (Blake2bPrefix n) → ByteString → ByteString Source #

sizeHash ∷ ∀ h proxy. HashAlgorithm h ⇒ proxy h → Word Source #

The size in bytes of the output of digest

data ByteString #

Instances

Instances details

Data ByteString
Instance details Defined in Data.ByteString.Internal.Type Methods gfoldl ∷ (∀ d b. Data d ⇒ c (d → b) → d → c b) → (∀ g. g → c g) → ByteString → c ByteString # gunfold ∷ (∀ b r. Data b ⇒ c (b → r) → c r) → (∀ r. r → c r) → Constr → c ByteString # toConstr ∷ ByteString → Constr # dataTypeOf ∷ ByteString → DataType # dataCast1 ∷ Typeable t ⇒ (∀ d. Data d ⇒ c (t d)) → Maybe (c ByteString) # dataCast2 ∷ Typeable t ⇒ (∀ d e. (Data d, Data e) ⇒ c (t d e)) → Maybe (c ByteString) # gmapT ∷ (∀ b. Data b ⇒ b → b) → ByteString → ByteString # gmapQl ∷ (r → r' → r) → r → (∀ d. Data d ⇒ d → r') → ByteString → r # gmapQr ∷ ∀ r r'. (r' → r → r) → r → (∀ d. Data d ⇒ d → r') → ByteString → r # gmapQ ∷ (∀ d. Data d ⇒ d → u) → ByteString → [u] # gmapQi ∷ Int → (∀ d. Data d ⇒ d → u) → ByteString → u # gmapM ∷ Monad m ⇒ (∀ d. Data d ⇒ d → m d) → ByteString → m ByteString # gmapMp ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → ByteString → m ByteString # gmapMo ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → ByteString → m ByteString #
IsString ByteString
Instance details Defined in Data.ByteString.Internal.Type Methods fromString ∷ String → ByteString #
Monoid ByteString
Instance details Defined in Data.ByteString.Internal.Type Methods mempty ∷ ByteString # mappend ∷ ByteString → ByteString → ByteString # mconcat ∷ [ByteString] → ByteString #
Semigroup ByteString
Instance details Defined in Data.ByteString.Internal.Type Methods (<>) ∷ ByteString → ByteString → ByteString # sconcat ∷ NonEmpty ByteString → ByteString # stimes ∷ Integral b ⇒ b → ByteString → ByteString #
IsList ByteString
Instance details Defined in Data.ByteString.Internal.Type Associated Types type Item ByteString # Methods fromList ∷ [Item ByteString] → ByteString # fromListN ∷ Int → [Item ByteString] → ByteString # toList ∷ ByteString → [Item ByteString] #
Read ByteString
Instance details Defined in Data.ByteString.Internal.Type Methods readsPrec ∷ Int → ReadS ByteString readList ∷ ReadS [ByteString] readPrec ∷ ReadPrec ByteString readListPrec ∷ ReadPrec [ByteString]
Show ByteString
Instance details Defined in Data.ByteString.Internal.Type Methods showsPrec ∷ Int → ByteString → ShowS # show ∷ ByteString → String # showList ∷ [ByteString] → ShowS #
FromCBOR ByteString
Instance details Defined in Cardano.Binary.FromCBOR Methods fromCBOR ∷ Decoder s ByteString Source # label ∷ Proxy ByteString → Text Source #
ToCBOR ByteString
Instance details Defined in Cardano.Binary.ToCBOR Methods toCBOR ∷ ByteString → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy ByteString → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [ByteString] → Size Source #
SignableRepresentation ByteString Source #
Instance details Defined in Cardano.Crypto.Util Methods getSignableRepresentation ∷ ByteString → ByteString Source #
NFData ByteString
Instance details Defined in Data.ByteString.Internal.Type Methods rnf ∷ ByteString → ()
Eq ByteString
Instance details Defined in Data.ByteString.Internal.Type Methods (==) ∷ ByteString → ByteString → Bool # (/=) ∷ ByteString → ByteString → Bool #
Ord ByteString
Instance details Defined in Data.ByteString.Internal.Type Methods compare ∷ ByteString → ByteString → Ordering # (<) ∷ ByteString → ByteString → Bool # (<=) ∷ ByteString → ByteString → Bool # (>) ∷ ByteString → ByteString → Bool # (>=) ∷ ByteString → ByteString → Bool # max ∷ ByteString → ByteString → ByteString # min ∷ ByteString → ByteString → ByteString #
Hashable ByteString
Instance details Defined in Data.Hashable.Class Methods hashWithSalt ∷ Int → ByteString → Int Source # hash ∷ ByteString → Int Source #
HeapWords ByteString
Instance details Defined in Cardano.HeapWords Methods heapWords ∷ ByteString → Int Source #
ByteArray ByteString
Instance details Defined in Data.ByteArray.Types Methods allocRet ∷ Int → (Ptr p → IO a) → IO (a, ByteString) Source #
ByteArrayAccess ByteString
Instance details Defined in Data.ByteArray.Types Methods length ∷ ByteString → Int Source # withByteArray ∷ ByteString → (Ptr p → IO a) → IO a Source # copyByteArrayToPtr ∷ ByteString → Ptr p → IO () Source #
MemPack ByteString
Instance details Defined in Data.MemPack Methods typeName ∷ String Source # packedByteCount ∷ ByteString → Int Source # packM ∷ ByteString → Pack s () Source # unpackM ∷ Buffer b ⇒ Unpack b ByteString Source #
Buffer ByteString
Instance details Defined in Data.MemPack.Buffer Methods bufferByteCount ∷ ByteString → Int Source # buffer ∷ ByteString → (ByteArray# → a) → (Addr# → a) → a Source #
NoThunks ByteString	Instance for string bytestrings Strict bytestrings shouldn't contain any thunks, but could, due to https://gitlab.haskell.org/ghc/ghc/issues/17290. However, such thunks can't retain any data that they shouldn't, and so it's safe to ignore such thunks.
Instance details Defined in NoThunks.Class Methods noThunks ∷ Context → ByteString → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → ByteString → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy ByteString → String Source #
Serialise ByteString	Since: serialise-0.2.0.0
Instance details Defined in Codec.Serialise.Class Methods encode ∷ ByteString → Encoding Source # decode ∷ Decoder s ByteString Source # encodeList ∷ [ByteString] → Encoding Source # decodeList ∷ Decoder s [ByteString] Source #
Lift ByteString
Instance details Defined in Data.ByteString.Internal.Type Methods lift ∷ Quote m ⇒ ByteString → m Exp liftTyped ∷ ∀ (m ∷ Type → Type). Quote m ⇒ ByteString → Code m ByteString
type Item ByteString
Instance details Defined in Data.ByteString.Internal.Type type Item ByteString = Word8

data Hash h a where Source #

Bundled Patterns

pattern UnsafeHash ∷ ∀ h a. HashAlgorithm h ⇒ ShortByteString → Hash h a

Instances

Instances details

HashAlgorithm h ⇒ IsString (Q (TExp (Hash h a))) Source #	This instance is meant to be used with `TemplateHaskell` `>>>` `import Cardano.Crypto.Hash.Class (Hash)``>>>` `import Cardano.Crypto.Hash.Short (ShortHash)``>>>` `:set -XTemplateHaskell``>>>` `:set -XOverloadedStrings``>>>` `let hash = $$("0xBADC0FFEE0DDF00D") :: Hash ShortHash ()``>>>` `print hash`"badc0ffee0ddf00d" `>>>` `let hash = $$("0123456789abcdef") :: Hash ShortHash ()``>>>` `print hash`"0123456789abcdef" `>>>` `let hash = $$("deadbeef") :: Hash ShortHash ()`<interactive>:5:15: error: • <Hash blake2b_prefix_8>: Expected in decoded form to be: 8 bytes, but got: 4 • In the Template Haskell splice $$("deadbeef") In the expression: $$("deadbeef") :: Hash ShortHash () In an equation for ‘hash’: hash = $$("deadbeef") :: Hash ShortHash () `>>>` `let hash = $$("123") :: Hash ShortHash ()`<interactive>:6:15: error: • <Hash blake2b_prefix_8>: Malformed hex: invalid bytestring size • In the Template Haskell splice $$("123") In the expression: $$("123") :: Hash ShortHash () In an equation for ‘hash’: hash = $$("123") :: Hash ShortHash ()
Instance details Defined in Cardano.Crypto.Hash.Class Methods fromString ∷ String → Q (TExp (Hash h a)) #
HashAlgorithm h ⇒ FromJSON (Hash h a) Source #
Instance details Defined in Cardano.Crypto.Hash.Class Methods parseJSON ∷ Value → Parser (Hash h a) Source # parseJSONList ∷ Value → Parser [Hash h a] Source # omittedField ∷ Maybe (Hash h a) Source #
HashAlgorithm h ⇒ FromJSONKey (Hash h a) Source #
Instance details Defined in Cardano.Crypto.Hash.Class Methods fromJSONKey ∷ FromJSONKeyFunction (Hash h a) Source # fromJSONKeyList ∷ FromJSONKeyFunction [Hash h a] Source #
HashAlgorithm h ⇒ ToJSON (Hash h a) Source #
Instance details Defined in Cardano.Crypto.Hash.Class Methods toJSON ∷ Hash h a → Value Source # toEncoding ∷ Hash h a → Encoding Source # toJSONList ∷ [Hash h a] → Value Source # toEncodingList ∷ [Hash h a] → Encoding Source # omitField ∷ Hash h a → Bool Source #
HashAlgorithm h ⇒ ToJSONKey (Hash h a) Source #
Instance details Defined in Cardano.Crypto.Hash.Class Methods toJSONKey ∷ ToJSONKeyFunction (Hash h a) Source # toJSONKeyList ∷ ToJSONKeyFunction [Hash h a] Source #
HashAlgorithm h ⇒ IsString (Hash h a) Source #
Instance details Defined in Cardano.Crypto.Hash.Class Methods fromString ∷ String → Hash h a #
Generic (Hash h a) Source #
Instance details Defined in Cardano.Crypto.Hash.Class Associated Types type Rep (Hash h a) ∷ Type → Type # Methods from ∷ Hash h a → Rep (Hash h a) x # to ∷ Rep (Hash h a) x → Hash h a #
HashAlgorithm h ⇒ Read (Hash h a) Source #
Instance details Defined in Cardano.Crypto.Hash.Class Methods readsPrec ∷ Int → ReadS (Hash h a) readList ∷ ReadS [Hash h a] readPrec ∷ ReadPrec (Hash h a) readListPrec ∷ ReadPrec [Hash h a]
Show (Hash h a) Source #
Instance details Defined in Cardano.Crypto.Hash.Class Methods showsPrec ∷ Int → Hash h a → ShowS # show ∷ Hash h a → String # showList ∷ [Hash h a] → ShowS #
(HashAlgorithm h, Typeable a) ⇒ FromCBOR (Hash h a) Source #
Instance details Defined in Cardano.Crypto.Hash.Class Methods fromCBOR ∷ Decoder s (Hash h a) Source # label ∷ Proxy (Hash h a) → Text Source #
(HashAlgorithm h, Typeable a) ⇒ ToCBOR (Hash h a) Source #
Instance details Defined in Cardano.Crypto.Hash.Class Methods toCBOR ∷ Hash h a → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (Hash h a) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [Hash h a] → Size Source #
NFData (Hash h a) Source #
Instance details Defined in Cardano.Crypto.Hash.Class Methods rnf ∷ Hash h a → ()
Eq (Hash h a) Source #
Instance details Defined in Cardano.Crypto.Hash.Class Methods (==) ∷ Hash h a → Hash h a → Bool # (/=) ∷ Hash h a → Hash h a → Bool #
Ord (Hash h a) Source #
Instance details Defined in Cardano.Crypto.Hash.Class Methods compare ∷ Hash h a → Hash h a → Ordering # (<) ∷ Hash h a → Hash h a → Bool # (<=) ∷ Hash h a → Hash h a → Bool # (>) ∷ Hash h a → Hash h a → Bool # (>=) ∷ Hash h a → Hash h a → Bool # max ∷ Hash h a → Hash h a → Hash h a # min ∷ Hash h a → Hash h a → Hash h a #
HeapWords (Hash h a) Source #
Instance details Defined in Cardano.Crypto.Hash.Class Methods heapWords ∷ Hash h a → Int Source #
HashAlgorithm h ⇒ MemPack (Hash h a) Source #
Instance details Defined in Cardano.Crypto.Hash.Class Methods typeName ∷ String Source # packedByteCount ∷ Hash h a → Int Source # packM ∷ Hash h a → Pack s () Source # unpackM ∷ Buffer b ⇒ Unpack b (Hash h a) Source #
NoThunks (Hash h a) Source #
Instance details Defined in Cardano.Crypto.Hash.Class Methods noThunks ∷ Context → Hash h a → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Hash h a → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (Hash h a) → String Source #
HashAlgorithm h ⇒ IsString (Code Q (Hash h a)) Source #
Instance details Defined in Cardano.Crypto.Hash.Class Methods fromString ∷ String → Code Q (Hash h a) #
type Rep (Hash h a) Source #
Instance details Defined in Cardano.Crypto.Hash.Class type Rep (Hash h a) = D1 ('MetaData "Hash" "Cardano.Crypto.Hash.Class" "cardano-crypto-class-2.2.3.0-inplace" 'True) (C1 ('MetaCons "UnsafeHashRep" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PackedBytes (SizeHash h)))))

data PackedBytes (n ∷ Nat) where Source #

Constructors

PackedBytes8 ∷ !Word64 → PackedBytes 8
PackedBytes28 ∷ !Word64 → !Word64 → !Word64 → !Word32 → PackedBytes 28
PackedBytes32 ∷ !Word64 → !Word64 → !Word64 → !Word64 → PackedBytes 32

Instances

Instances details

NFData (PackedBytes n) Source #
Instance details Defined in Cardano.Crypto.PackedBytes Methods rnf ∷ PackedBytes n → ()
Eq (PackedBytes n) Source #
Instance details Defined in Cardano.Crypto.PackedBytes Methods (==) ∷ PackedBytes n → PackedBytes n → Bool # (/=) ∷ PackedBytes n → PackedBytes n → Bool #
Ord (PackedBytes n) Source #
Instance details Defined in Cardano.Crypto.PackedBytes Methods compare ∷ PackedBytes n → PackedBytes n → Ordering # (<) ∷ PackedBytes n → PackedBytes n → Bool # (<=) ∷ PackedBytes n → PackedBytes n → Bool # (>) ∷ PackedBytes n → PackedBytes n → Bool # (>=) ∷ PackedBytes n → PackedBytes n → Bool # max ∷ PackedBytes n → PackedBytes n → PackedBytes n # min ∷ PackedBytes n → PackedBytes n → PackedBytes n #
KnownNat n ⇒ MemPack (PackedBytes n) Source #
Instance details Defined in Cardano.Crypto.PackedBytes Methods typeName ∷ String Source # packedByteCount ∷ PackedBytes n → Int Source # packM ∷ PackedBytes n → Pack s () Source # unpackM ∷ Buffer b ⇒ Unpack b (PackedBytes n) Source #
NoThunks (PackedBytes n) Source #
Instance details Defined in Cardano.Crypto.PackedBytes Methods noThunks ∷ Context → PackedBytes n → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → PackedBytes n → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (PackedBytes n) → String Source #
KnownNat n ⇒ Serialise (PackedBytes n) Source #
Instance details Defined in Cardano.Crypto.PackedBytes Methods encode ∷ PackedBytes n → Encoding Source # decode ∷ Decoder s (PackedBytes n) Source # encodeList ∷ [PackedBytes n] → Encoding Source # decodeList ∷ Decoder s [PackedBytes n] Source #

Core operations

hashWith ∷ ∀ h a. HashAlgorithm h ⇒ (a → ByteString) → a → Hash h a Source #

Hash the given value, using a serialisation function to turn it into bytes.

hashWithSerialiser ∷ ∀ h a. HashAlgorithm h ⇒ (a → Encoding) → a → Hash h a Source #

A variation on hashWith, but specially for CBOR encodings.

Conversions

castHash ∷ Hash h a → Hash h b Source #

Cast the type of the hashed data.

The Hash type has a phantom type parameter to indicate what type the hash is of. It is sometimes necessary to fake this and hash a value of one type and use it where as hash of a different type is expected.

hashToBytes ∷ Hash h a → ByteString Source #

The representation of the hash as bytes.

hashFromBytes Source #

Arguments

∷ ∀ h a. HashAlgorithm h
⇒ ByteString	It must have an exact length, as given by `sizeHash`.
→ Maybe (Hash h a)

Make a hash from it bytes representation.

hashToBytesShort ∷ Hash h a → ShortByteString Source #

The representation of the hash as bytes, as a ShortByteString.

hashFromBytesShort Source #

Arguments

∷ ∀ h a. HashAlgorithm h
⇒ ShortByteString	It must be a buffer of exact length, as given by `sizeHash`.
→ Maybe (Hash h a)

Make a hash from it bytes representation, as a ShortByteString.

hashFromOffsetBytesShort Source #

Arguments

∷ ∀ h a. HashAlgorithm h
⇒ ShortByteString	It must be a buffer that contains at least `sizeHash` many bytes staring at an offset.
→ Int	Offset in number of bytes
→ Maybe (Hash h a)

Just like hashFromBytesShort, but allows using a region of a ShortByteString.

hashToPackedBytes ∷ Hash h a → PackedBytes (SizeHash h) Source #

O(1) - Get the underlying hash representation

hashFromPackedBytes ∷ PackedBytes (SizeHash h) → Hash h a Source #

O(1) - Construct hash from the underlying representation

Rendering and parsing

hashToBytesAsHex ∷ Hash h a → ByteString Source #

Convert the hash to hex encoding, as ByteString.

hashFromBytesAsHex ∷ HashAlgorithm h ⇒ ByteString → Maybe (Hash h a) Source #

Make a hash from hex-encoded ByteString representation.

This can fail for the same reason as hashFromBytes, or because the input is invalid hex. The whole byte string must be valid hex, not just a prefix.

hashToTextAsHex ∷ Hash h a → Text Source #

Convert the hash to hex encoding, as Text.

hashFromTextAsHex ∷ HashAlgorithm h ⇒ Text → Maybe (Hash h a) Source #

Make a hash from hex-encoded Text representation.

This can fail for the same reason as hashFromBytes, or because the input is invalid hex. The whole byte string must be valid hex, not just a prefix.

hashToStringAsHex ∷ Hash h a → String Source #

Convert the hash to hex encoding, as String.

hashFromStringAsHex ∷ HashAlgorithm h ⇒ String → Maybe (Hash h a) Source #

Make a hash from hex-encoded String representation.

This can fail for the same reason as hashFromBytes, or because the input is invalid hex. The whole byte string must be valid hex, not just a prefix.

Other operations

xor ∷ Hash h a → Hash h a → Hash h a Source #

XOR two hashes together

Deprecated

hash ∷ ∀ h a. (HashAlgorithm h, ToCBOR a) ⇒ a → Hash h a Source #

Deprecated: Use hashWith or hashWithSerialiser

fromHash ∷ Hash h a → Natural Source #

Deprecated: Use bytesToNatural . hashToBytes

hashRaw ∷ ∀ h a. HashAlgorithm h ⇒ (a → ByteString) → a → Hash h a Source #

Deprecated: Use hashWith

getHash ∷ Hash h a → ByteString Source #

Deprecated: Use hashToBytes

getHashBytesAsHex ∷ Hash h a → ByteString Source #

Deprecated: Use hashToBytesAsHex