libghc-cryptohash-conduit-doc 0.1.1-8build13 / usr / share / doc / libghc-cryptohash-conduit-doc / html / cryptohash-conduit.txt

-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | cryptohash conduit
--   
--   Support all the <tt>cryptohash</tt> package using conduits from the
--   <tt>conduit</tt> package.
@package cryptohash-conduit
@version 0.1.1


-- | A module containing Conduit facilities for hash based functions.
--   
--   this module is vaguely similar to the crypto-conduit part related to
--   hash on purpose, as to provide an upgrade path. The api documentation
--   is pulled directly from this package and adapted, and thus are
--   originally copyright Felipe Lessa.
module Crypto.Hash.Conduit

-- | A <a>Sink</a> that hashes a stream of <a>ByteString</a><tt>s</tt> and
--   creates a digest <tt>d</tt>.
sinkHash :: (Monad m, HashAlgorithm hash) => Consumer ByteString m (Digest hash)

-- | Hashes the whole contents of the given file in constant memory. This
--   function is just a convenient wrapper around <a>sinkHash</a> defined
--   as:
--   
--   <pre>
--   hashFile fp = <a>liftIO</a> $ <a>runResourceT</a> (<a>sourceFile</a> fp <a>$$</a> <a>sinkHash</a>)
--   </pre>
hashFile :: (MonadIO m, HashAlgorithm hash) => FilePath -> m (Digest hash)