/usr/share/doc/libghc-cryptohash-conduit-doc/html/Crypto-Hash-Conduit.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Crypto.Hash.Conduit</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Crypto-Hash-Conduit.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Crypto-Hash-Conduit.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">cryptohash-conduit-0.1.1: cryptohash conduit</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>License</th><td>BSD-style</td></tr><tr><th>Maintainer</th><td>Vincent Hanquez &lt;vincent@snarc.org&gt;</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Portability</th><td>unknown</td></tr><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell98</td></tr></table><p class="caption">Crypto.Hash.Conduit</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Cryptographic hash functions</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>A module containing Conduit facilities for hash based functions.</p><p>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.</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:sinkHash">sinkHash</a> :: (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Control-Monad.html#t:Monad">Monad</a> m, <a href="file:///usr/share/doc/libghc-cryptohash-doc/html/Crypto-Hash-Types.html#t:HashAlgorithm">HashAlgorithm</a> hash) =&gt; <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.6.0/Data-ByteString.html#t:ByteString">ByteString</a> m (<a href="file:///usr/share/doc/libghc-cryptohash-doc/html/Crypto-Hash-Types.html#t:Digest">Digest</a> hash)</li><li class="src short"><a href="#v:hashFile">hashFile</a> :: (<a href="file:///usr/share/doc/ghc-doc/html/libraries/transformers-0.4.2.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m, <a href="file:///usr/share/doc/libghc-cryptohash-doc/html/Crypto-Hash-Types.html#t:HashAlgorithm">HashAlgorithm</a> hash) =&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:FilePath">FilePath</a> -&gt; m (<a href="file:///usr/share/doc/libghc-cryptohash-doc/html/Crypto-Hash-Types.html#t:Digest">Digest</a> hash)</li></ul></div><div id="interface"><h1 id="g:1">Cryptographic hash functions</h1><div class="top"><p class="src"><a name="v:sinkHash" class="def">sinkHash</a> :: (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Control-Monad.html#t:Monad">Monad</a> m, <a href="file:///usr/share/doc/libghc-cryptohash-doc/html/Crypto-Hash-Types.html#t:HashAlgorithm">HashAlgorithm</a> hash) =&gt; <a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Consumer">Consumer</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.6.0/Data-ByteString.html#t:ByteString">ByteString</a> m (<a href="file:///usr/share/doc/libghc-cryptohash-doc/html/Crypto-Hash-Types.html#t:Digest">Digest</a> hash) <a href="src/Crypto-Hash-Conduit.html#sinkHash" class="link">Source</a></p><div class="doc"><p>A <code><a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Sink">Sink</a></code> that hashes a stream of <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.6.0/Data-ByteString.html#t:ByteString">ByteString</a></code><code>s</code> and
 creates a digest <code>d</code>.</p></div></div><div class="top"><p class="src"><a name="v:hashFile" class="def">hashFile</a> :: (<a href="file:///usr/share/doc/ghc-doc/html/libraries/transformers-0.4.2.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m, <a href="file:///usr/share/doc/libghc-cryptohash-doc/html/Crypto-Hash-Types.html#t:HashAlgorithm">HashAlgorithm</a> hash) =&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:FilePath">FilePath</a> -&gt; m (<a href="file:///usr/share/doc/libghc-cryptohash-doc/html/Crypto-Hash-Types.html#t:Digest">Digest</a> hash) <a href="src/Crypto-Hash-Conduit.html#hashFile" class="link">Source</a></p><div class="doc"><p>Hashes the whole contents of the given file in constant
 memory.  This function is just a convenient wrapper around
 <code><a href="Crypto-Hash-Conduit.html#v:sinkHash">sinkHash</a></code> defined as:</p><pre>hashFile fp = <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/transformers-0.4.2.0/Control-Monad-IO-Class.html#v:liftIO">liftIO</a></code> $ <code><a href="file:///usr/share/doc/libghc-resourcet-doc/html/Control-Monad-Trans-Resource.html#v:runResourceT">runResourceT</a></code> (<code><a href="file:///usr/share/doc/libghc-conduit-extra-doc/html/Data-Conduit-Binary.html#v:sourceFile">sourceFile</a></code> fp <code><a href="file:///usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#v:-36--36-">$$</a></code> <code><a href="Crypto-Hash-Conduit.html#v:sinkHash">sinkHash</a></code>)
</pre></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.16.1</p></div></body></html>
libghc-cryptohash-conduit-doc 0.1.1-6build1 / usr / share / doc / libghc-cryptohash-conduit-doc / html / Crypto-Hash-Conduit.html
