/usr/share/doc/libghc-pipes-zlib-doc/html/Pipes-Zlib.html is in libghc-pipes-zlib-doc 0.4.0-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 | <!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>Pipes.Zlib</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_Pipes-Zlib.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Pipes-Zlib.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">pipes-zlib-0.4.0: Zlib compression and decompression for Pipes streams</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr></table><p class="caption">Pipes.Zlib</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Streams
</a></li><li><a href="#g:2">Compression level
</a></li><li><a href="#g:3">Window size
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This module exports utilities to compress and decompress <code>pipes</code> streams
using the zlib compression codec.
</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:decompress">decompress</a> :: <a href="/usr/share/doc/libghc-transformers-doc/html/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:WindowBits">WindowBits</a> -> <a href="/usr/share/doc/libghc-pipes-doc/html/Pipes-Core.html#t:Producer-39-">Producer'</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a> m r -> <a href="/usr/share/doc/libghc-pipes-doc/html/Pipes-Core.html#t:Producer-39-">Producer'</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a> m r</li><li class="src short"><a href="#v:compress">compress</a> :: <a href="/usr/share/doc/libghc-transformers-doc/html/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:CompressionLevel">CompressionLevel</a> -> <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:WindowBits">WindowBits</a> -> <a href="/usr/share/doc/libghc-pipes-doc/html/Pipes-Core.html#t:Producer-39-">Producer'</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a> m r -> <a href="/usr/share/doc/libghc-pipes-doc/html/Pipes-Core.html#t:Producer-39-">Producer'</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a> m r</li><li class="src short"><a href="#v:defaultCompression">defaultCompression</a> :: <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:CompressionLevel">CompressionLevel</a></li><li class="src short"><a href="#v:noCompression">noCompression</a> :: <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:CompressionLevel">CompressionLevel</a></li><li class="src short"><a href="#v:bestSpeed">bestSpeed</a> :: <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:CompressionLevel">CompressionLevel</a></li><li class="src short"><a href="#v:bestCompression">bestCompression</a> :: <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:CompressionLevel">CompressionLevel</a></li><li class="src short"><a href="#v:compressionLevel">compressionLevel</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:CompressionLevel">CompressionLevel</a></li><li class="src short"><a href="#v:defaultWindowBits">defaultWindowBits</a> :: <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:WindowBits">WindowBits</a></li><li class="src short"><a href="#v:windowBits">windowBits</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:WindowBits">WindowBits</a></li></ul></div><div id="interface"><h1 id="g:1">Streams
</h1><div class="top"><p class="src"><a name="v:decompress" class="def">decompress</a><a href="src/Pipes-Zlib.html#decompress" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/libghc-transformers-doc/html/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m</td><td class="doc empty"> </td></tr><tr><td class="src">=> <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:WindowBits">WindowBits</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/libghc-pipes-doc/html/Pipes-Core.html#t:Producer-39-">Producer'</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a> m r</td><td class="doc"><p>Compressed stream
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/libghc-pipes-doc/html/Pipes-Core.html#t:Producer-39-">Producer'</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a> m r</td><td class="doc"><p>Decompressed stream
</p></td></tr></table></div><div class="doc"><p>Decompress bytes flowing from a <code><a href="/usr/share/doc/libghc-pipes-doc/html/Pipes-Core.html#t:Producer">Producer</a></code>.
</p><p>See the <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib.html">Codec.Compression.Zlib</a> module for details about <code><a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:WindowBits">WindowBits</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:compress" class="def">compress</a><a href="src/Pipes-Zlib.html#compress" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/libghc-transformers-doc/html/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m</td><td class="doc empty"> </td></tr><tr><td class="src">=> <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:CompressionLevel">CompressionLevel</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:WindowBits">WindowBits</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/libghc-pipes-doc/html/Pipes-Core.html#t:Producer-39-">Producer'</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a> m r</td><td class="doc"><p>Decompressed stream
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/libghc-pipes-doc/html/Pipes-Core.html#t:Producer-39-">Producer'</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a> m r</td><td class="doc"><p>Compressed stream
</p></td></tr></table></div><div class="doc"><p>Compress bytes flowing from a <code><a href="/usr/share/doc/libghc-pipes-doc/html/Pipes-Core.html#t:Producer">Producer</a></code>.
</p><p>See the <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib.html">Codec.Compression.Zlib</a> module for details about
<code><a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:CompressionLevel">CompressionLevel</a></code> and <code><a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:WindowBits">WindowBits</a></code>.
</p></div></div><h1 id="g:2">Compression level
</h1><div class="doc"><p>The following are re-exported from <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib.html">Codec.Compression.Zlib</a> for your
convenience.
</p></div><div class="top"><p class="src"><a name="v:defaultCompression" class="def">defaultCompression</a> :: <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:CompressionLevel">CompressionLevel</a></p><div class="doc"><p>The default compression level is 6 (that is, biased towards higher
compression at expense of speed).
</p></div></div><div class="top"><p class="src"><a name="v:noCompression" class="def">noCompression</a> :: <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:CompressionLevel">CompressionLevel</a></p><div class="doc"><p>No compression, just a block copy.
</p></div></div><div class="top"><p class="src"><a name="v:bestSpeed" class="def">bestSpeed</a> :: <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:CompressionLevel">CompressionLevel</a></p><div class="doc"><p>The fastest compression method (less compression)
</p></div></div><div class="top"><p class="src"><a name="v:bestCompression" class="def">bestCompression</a> :: <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:CompressionLevel">CompressionLevel</a></p><div class="doc"><p>The slowest compression method (best compression).
</p></div></div><div class="top"><p class="src"><a name="v:compressionLevel" class="def">compressionLevel</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:CompressionLevel">CompressionLevel</a></p><div class="doc"><p>A specific compression level between 0 and 9.
</p></div></div><h1 id="g:3">Window size
</h1><div class="doc"><p>The following are re-exported from <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib.html">Codec.Compression.Zlib</a> for your
convenience.
</p></div><div class="top"><p class="src"><a name="v:defaultWindowBits" class="def">defaultWindowBits</a> :: <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:WindowBits">WindowBits</a></p><div class="doc"><p>The default <code><a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:WindowBits">WindowBits</a></code> is 15 which is also the maximum size.
</p></div></div><div class="top"><p class="src"><a name="v:windowBits" class="def">windowBits</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/libghc-zlib-doc/html/Codec-Compression-Zlib-Internal.html#t:WindowBits">WindowBits</a></p><div class="doc"><p>A specific compression window size, specified in bits in the range <code>8..15</code>
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.13.2</p></div></body></html>
|