Modulecardano-crypto-class-2.5.1.0

Cardano.Crypto.Hash.Class

3 types
2 classes
28 values

Packagecardano-crypto-class-2.5.1.0
Exports34
LicenceApache-2.0
SourceType.hs

valuecastHash :: Hash h a -> Hash h b

valuefromHash :: Hash h a -> Natural

Deprecated. Use bytesToNatural . hashToBytes

valuegetHash :: Hash h a -> ByteString

Deprecated. Use hashToBytes

valuegetHashBytesAsHex :: Hash h a -> ByteString

Deprecated. Use hashToBytesAsHex

valuehash :: (HashAlgorithm h, ToCBOR a) => a -> Hash h a

Deprecated. Use hashWith or hashWithSerialiser

valuehashFromByteStringM

:: (HashAlgorithm h, MonadFail m)
=> ByteString
-> m (Hash h a)

valuehashFromBytes :: HashAlgorithm h => ByteString -> Maybe (Hash h a)

valuehashFromBytesAsHex :: HashAlgorithm h => ByteString -> Maybe (Hash h a)

valuehashFromBytesShort :: HashAlgorithm h => ShortByteString -> Maybe (Hash h a)

valuehashFromOffsetBytesShort

:: HashAlgorithm h
=> ShortByteString
-> Int
-> Maybe (Hash h a)

valuehashFromPackedBytes :: PackedBytes (HashSize h) -> Hash h a

valuehashFromStringAsHex :: HashAlgorithm h => String -> Maybe (Hash h a)

valuehashFromTextAsHex :: HashAlgorithm h => Text -> Maybe (Hash h a)

valuehashRaw :: HashAlgorithm h => (a -> ByteString) -> a -> Hash h a

Deprecated. Use hashWith

valuehashSize :: HashAlgorithm h => proxy h -> Word

valuehashToByteArray :: Hash h a -> ByteArray

valuehashToBytes :: Hash h a -> ByteString

valuehashToBytesAsHex :: Hash h a -> ByteString

valuehashToBytesShort :: Hash h a -> ShortByteString

valuehashToPackedBytes :: Hash h a -> PackedBytes (HashSize h)

valuehashToStringAsHex :: Hash h a -> String

valuehashToTextAsHex :: Hash h a -> Text

valuehashWith :: HashAlgorithm h => (a -> ByteString) -> a -> Hash h a

valuehashWithSerialiser :: HashAlgorithm h => (a -> Encoding) -> a -> Hash h a

valuesizeHash :: HashAlgorithm h => proxy h -> Word

Deprecated. In favor of hashSize

valuewithHashContext

:: (IncrementalHashAlgorithm h, MonadST m)
=> HashContext h (PrimState m) -> m a
-> m (a, Hash h b)

valuewithHashContextST

:: IncrementalHashAlgorithm h
=> forall s. HashContext h s -> ST s a
-> (a, Hash h b)

valuexor :: Hash h a -> Hash h a -> Hash h a

datadata ByteString

A space-efficient representation of a Word8 vector, supporting many efficient operations.

A ByteString contains 8-bit bytes, or by using the operations from Data.ByteString.Char8 it can be interpreted as containing 8-bit characters.

Instances29IsList, Eq, Data, Ord, Read, Show, …

IsList ByteStringDefined in bytestring-0.12.2.0 · Data.ByteString.Internal.Type
Eq ByteStringDefined in bytestring-0.12.2.0 · Data.ByteString.Internal.Type
Data ByteStringDefined in bytestring-0.12.2.0 · Data.ByteString.Internal.Type
Ord ByteStringDefined in bytestring-0.12.2.0 · Data.ByteString.Internal.Type
Read ByteStringDefined in bytestring-0.12.2.0 · Data.ByteString.Internal.Type
Show ByteStringDefined in bytestring-0.12.2.0 · Data.ByteString.Internal.Type
IsString ByteStringDefined in bytestring-0.12.2.0 · Data.ByteString.Internal.Type
Beware: fromString truncates multi-byte characters to octets. e.g. "枯朶に烏のとまりけり秋の暮" becomes �6k�nh~�Q��n�
Semigroup ByteStringDefined in bytestring-0.12.2.0 · Data.ByteString.Internal.Type
Monoid ByteStringDefined in bytestring-0.12.2.0 · Data.ByteString.Internal.Type
NFData ByteStringDefined in bytestring-0.12.2.0 · Data.ByteString.Internal.Type
Binary ByteStringDefined in binary-0.8.9.3 · Data.Binary.Class
Hashable ByteStringDefined in hashable-1.5.1.0 · Data.Hashable.Class
Input ByteStringDefined in appar-0.1.8 · Text.Appar.Input
Serialise ByteStringDefined in serialise-0.2.6.1 · Codec.Serialise.Class
MemPack ByteStringDefined in mempack-0.2.1.0 · Data.MemPack
Buffer ByteStringDefined in mempack-0.2.1.0 · Data.MemPack.Buffer
NoThunks ByteStringDefined in nothunks-0.3.1 · NoThunks.Class
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.
FromCBOR ByteStringDefined in cardano-binary-1.9.1.0 · Cardano.Binary.FromCBOR
ToCBOR ByteStringDefined in cardano-binary-1.9.1.0 · Cardano.Binary.ToCBOR
ByteArray ByteStringDefined in memory-0.18.0 · Data.ByteArray.Types
ByteArrayAccess ByteStringDefined in memory-0.18.0 · Data.ByteArray.Types
HeapWords ByteStringDefined in heapwords-0.1.0.2 · Cardano.HeapWords
SignableRepresentation ByteStringDefined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Util
Lift ByteStringDefined in bytestring-0.12.2.0 · Data.ByteString.Internal.Type
Strict ByteString ByteStringDefined in strict-0.5.1 · Data.Strict.Classes
Convertable Double ByteStringDefined in double-conversion-2.0.5.0 · Data.Double.Conversion.Convertable
Convertable Float ByteStringDefined in double-conversion-2.0.5.0 · Data.Double.Conversion.Convertable
Monad m => Stream ByteString m CharDefined in parsec-3.1.18.0 · Text.Parsec.Prim
type Item ByteString = Word8Defined in bytestring-0.12.2.0 · Data.ByteString.Internal.Type

newtypenewtype Hash h a

Instances20Eq, Ord, Read, Show, Generic, Storable, …

HashAlgorithm h => IsString (Q (TExp (Hash h a)))Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Class
Eq (Hash h a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Class
Ord (Hash h a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Class
HashAlgorithm h => Read (Hash h a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Class
Show (Hash h a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Class
HashAlgorithm h => IsString (Hash h a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Class
Generic (Hash h a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Class
HashAlgorithm h => Storable (Hash h a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Class
NFData (Hash h a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Class
HashAlgorithm h => FromJSON (Hash h a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Class
HashAlgorithm h => FromJSONKey (Hash h a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Class
HashAlgorithm h => ToJSON (Hash h a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Class
HashAlgorithm h => ToJSONKey (Hash h a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Class
HashAlgorithm h => MemPack (Hash h a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Class
NoThunks (Hash h a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Class
(HashAlgorithm h, Typeable a) => FromCBOR (Hash h a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Class
(HashAlgorithm h, Typeable a) => ToCBOR (Hash h a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Class
HeapWords (Hash h a)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Class
HashAlgorithm h => IsString (Code Q (Hash h a))Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Class
type Rep (Hash h a) = D1 ('MetaData "Hash" "Cardano.Crypto.Hash.Class" "cardano-crypto-class-2.5.1.0-2YbSTqCvsz43JrgaH5m8D0" 'True) (C1 ('MetaCons "UnsafeHashRep" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PackedBytes (HashSize h)))))Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Class

patternpattern UnsafeHash :: (HashAlgorithm h, HasCallStack) => ShortByteString -> Hash h a

classclass (KnownNat (HashSize h), Typeable h) => HashAlgorithm h where

Associated types

type family HashSize h :: Nat
type family SizeHash h :: Nat

Methods

hashAlgorithmName :: proxy h -> String
digest :: proxy h -> ByteString -> ByteString

Instances10HashAlgorithm, …

HashAlgorithm Blake2b_224Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Blake2b
HashAlgorithm Blake2b_256Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Blake2b
HashAlgorithm Keccak256Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Keccak256
HashAlgorithm NeverHashDefined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.NeverUsed
HashAlgorithm RIPEMD160Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.RIPEMD160
HashAlgorithm SHA256Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.SHA256
HashAlgorithm SHA3_256Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.SHA3_256
HashAlgorithm SHA3_512Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.SHA3_512
HashAlgorithm SHA512Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.SHA512
(KnownNat n, CmpNat n 33 ~ 'LT) => HashAlgorithm (Blake2bPrefix n)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Short

classclass HashAlgorithm h => IncrementalHashAlgorithm h where

Associated types

data family HashContext h s

Methods

hashInit :: MonadST m => m (HashContext h (PrimState m))
hashUpdate :: MonadST m => HashContext h (PrimState m) -> ByteString -> m ()
hashFinalize :: MonadST m => HashContext h (PrimState m) -> m (Hash h a)

Instances2IncrementalHashAlgorithm

IncrementalHashAlgorithm Blake2b_224Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Blake2b
IncrementalHashAlgorithm Blake2b_256Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.Hash.Blake2b

datadata PackedBytes (n :: Nat) where

Constructors

PackedBytes8 :: !Word64 -> PackedBytes 8
PackedBytes28 :: !Word64 -> !Word64 -> !Word64 -> !Word32 -> PackedBytes 28
PackedBytes32 :: !Word64 -> !Word64 -> !Word64 -> !Word64 -> PackedBytes 32

Instances11Eq, Ord, Show, Storable, NFData, MemPack, …

Eq (PackedBytes n)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.PackedBytes.Internal
Ord (PackedBytes n)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.PackedBytes.Internal
KnownNat n => Show (PackedBytes n)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.PackedBytes.Internal
KnownNat n => Storable (PackedBytes n)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.PackedBytes.Internal
NFData (PackedBytes n)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.PackedBytes.Internal
KnownNat n => MemPack (PackedBytes n)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.PackedBytes.Internal
NoThunks (PackedBytes n)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.PackedBytes.Internal
KnownNat n => FromCBOR (PackedBytes n)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.PackedBytes.Internal
KnownNat n => ToCBOR (PackedBytes n)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.PackedBytes.Internal
KnownNat n => FixedSizeCodec (PackedBytes n)Defined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.PackedBytes.Internal
type FixedSize (PackedBytes n) = nDefined in cardano-crypto-class-2.5.1.0 · Cardano.Crypto.PackedBytes.Internal