Data.ContentStore.Digest

Functions for working with digest algorithms as used by the content store

Documentation

data DigestAlgorithm

A DigestAlgorithm represents one specific hash algorithm.

getDigestAlgorithm :: Text -> Maybe DigestAlgorithm

Given the Text name of a digest algorithm, return a DigestAlgorithm (or Nothing if we don't recognize the DigestAlgorithm's name).

digestName :: DigestAlgorithm -> String

Get the name of this DigestAlgorithm.

digestSize :: DigestAlgorithm -> Int

The size of the ObjectDigest returned by this DigestAlgorithm.

digestInit :: DigestAlgorithm -> DigestContext

Initialize a new DigestContext for this DigestAlgorithm.

data DigestContext

Holds the context for a given instance of a DigestAlgorithm.

digestUpdate :: ByteArrayAccess ba => DigestContext -> ba -> DigestContext

Update the DigestContext with one 'ByteString'/'Bytes'/etc item.

digestUpdates :: ByteArrayAccess ba => DigestContext -> [ba] -> DigestContext

Update the DigestContext with many 'ByteString'/'Bytes'/etc. items.

digestFinalize :: DigestContext -> ObjectDigest

Finish the digest, returning an ObjectDigest.

digestByteString :: DigestAlgorithm -> ByteString -> ObjectDigest

Hash a strict ByteString into an ObjectDigest.

digestLazyByteString :: DigestAlgorithm -> ByteString -> ObjectDigest

Hash a lazy ByteString into an ObjectDigest.

data ObjectDigest

ObjectDigest is the (binary) representation of a digest.

Instances

Eq ObjectDigest

Methods

(==) :: ObjectDigest -> ObjectDigest -> Bool

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

Ord ObjectDigest

Methods

compare :: ObjectDigest -> ObjectDigest -> Ordering

(<) :: ObjectDigest -> ObjectDigest -> Bool

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

(>) :: ObjectDigest -> ObjectDigest -> Bool

(>=) :: ObjectDigest -> ObjectDigest -> Bool

max :: ObjectDigest -> ObjectDigest -> ObjectDigest

min :: ObjectDigest -> ObjectDigest -> ObjectDigest

Show ObjectDigest

Methods

showsPrec :: Int -> ObjectDigest -> ShowS

show :: ObjectDigest -> String

showList :: [ObjectDigest] -> ShowS

ByteArrayAccess ObjectDigest

Methods

length :: ObjectDigest -> Int

withByteArray :: ObjectDigest -> (Ptr p -> IO a) -> IO a

toHex :: ObjectDigest -> String

Convert an ObjectDigest to its hex representation. TODO: probably more efficient if we can just coerce the converted Bytes..

fromByteString :: ByteArrayAccess ba => DigestAlgorithm -> ba -> Maybe ObjectDigest

Check and convert a ByteString into an ObjectDigest.