<!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>System.IO.Streams.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_System-IO-Streams-Zlib.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/System-IO-Streams-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">io-streams-1.1.4.5: Simple, composable, and easy-to-use stream I/O</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">System.IO.Streams.Zlib</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">ByteString decompression
</a></li><li><a href="#g:2">ByteString compression
</a></li><li><a href="#g:3">Builder compression
</a></li><li><a href="#g:4">Compression level
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Interface to <code>zlib</code> and <code>gzip</code> compression for <code>Bytestring</code>s and <code><a href="/usr/share/doc/ghc/html/libraries/blaze-builder-0.3.1.1/Blaze-ByteString-Builder-Internal-Types.html#t:Builder">Builder</a></code>s
</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:gunzip">gunzip</a> :: <a href="System-IO-Streams-Internal.html#t:InputStream">InputStream</a> <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="System-IO-Streams-Internal.html#t:InputStream">InputStream</a> <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a>)</li><li class="src short"><a href="#v:decompress">decompress</a> :: <a href="System-IO-Streams-Internal.html#t:InputStream">InputStream</a> <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="System-IO-Streams-Internal.html#t:InputStream">InputStream</a> <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a>)</li><li class="src short"><a href="#v:gzip">gzip</a> :: <a href="System-IO-Streams-Zlib.html#t:CompressionLevel">CompressionLevel</a> -> <a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a> <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a> <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a>)</li><li class="src short"><a href="#v:compress">compress</a> :: <a href="System-IO-Streams-Zlib.html#t:CompressionLevel">CompressionLevel</a> -> <a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a> <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a> <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a>)</li><li class="src short"><a href="#v:gzipBuilder">gzipBuilder</a> :: <a href="System-IO-Streams-Zlib.html#t:CompressionLevel">CompressionLevel</a> -> <a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a> <a href="/usr/share/doc/ghc/html/libraries/blaze-builder-0.3.1.1/Blaze-ByteString-Builder-Internal-Types.html#t:Builder">Builder</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a> <a href="/usr/share/doc/ghc/html/libraries/blaze-builder-0.3.1.1/Blaze-ByteString-Builder-Internal-Types.html#t:Builder">Builder</a>)</li><li class="src short"><a href="#v:compressBuilder">compressBuilder</a> :: <a href="System-IO-Streams-Zlib.html#t:CompressionLevel">CompressionLevel</a> -> <a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a> <a href="/usr/share/doc/ghc/html/libraries/blaze-builder-0.3.1.1/Blaze-ByteString-Builder-Internal-Types.html#t:Builder">Builder</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a> <a href="/usr/share/doc/ghc/html/libraries/blaze-builder-0.3.1.1/Blaze-ByteString-Builder-Internal-Types.html#t:Builder">Builder</a>)</li><li class="src short"><span class="keyword">newtype</span> <a href="#t:CompressionLevel">CompressionLevel</a> = <a href="#v:CompressionLevel">CompressionLevel</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:defaultCompressionLevel">defaultCompressionLevel</a> :: <a href="System-IO-Streams-Zlib.html#t:CompressionLevel">CompressionLevel</a></li></ul></div><div id="interface"><h1 id="g:1">ByteString decompression
</h1><div class="top"><p class="src"><a name="v:gunzip" class="def">gunzip</a> :: <a href="System-IO-Streams-Internal.html#t:InputStream">InputStream</a> <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="System-IO-Streams-Internal.html#t:InputStream">InputStream</a> <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a>)<a href="src/System-IO-Streams-Zlib.html#gunzip" class="link">Source</a></p><div class="doc"><p>Decompress an <code><a href="System-IO-Streams-Internal.html#t:InputStream">InputStream</a></code> of strict <code><a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a></code>s from the <code>gzip</code> format
</p></div></div><div class="top"><p class="src"><a name="v:decompress" class="def">decompress</a> :: <a href="System-IO-Streams-Internal.html#t:InputStream">InputStream</a> <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="System-IO-Streams-Internal.html#t:InputStream">InputStream</a> <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a>)<a href="src/System-IO-Streams-Zlib.html#decompress" class="link">Source</a></p><div class="doc"><p>Decompress an <code><a href="System-IO-Streams-Internal.html#t:InputStream">InputStream</a></code> of strict <code><a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a></code>s from the <code>zlib</code> format
</p></div></div><h1 id="g:2">ByteString compression
</h1><div class="top"><p class="src"><a name="v:gzip" class="def">gzip</a> :: <a href="System-IO-Streams-Zlib.html#t:CompressionLevel">CompressionLevel</a> -> <a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a> <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a> <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a>)<a href="src/System-IO-Streams-Zlib.html#gzip" class="link">Source</a></p><div class="doc"><p>Convert an <code><a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a></code> that consumes compressed <code><a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a></code>s into an
<code><a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a></code> that consumes uncompressed <code><a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a></code>s in the <code>gzip</code> format
</p></div></div><div class="top"><p class="src"><a name="v:compress" class="def">compress</a> :: <a href="System-IO-Streams-Zlib.html#t:CompressionLevel">CompressionLevel</a> -> <a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a> <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a> <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a>)<a href="src/System-IO-Streams-Zlib.html#compress" class="link">Source</a></p><div class="doc"><p>Convert an <code><a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a></code> that consumes compressed <code><a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a></code>s into an
<code><a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a></code> that consumes uncompressed <code><a href="/usr/share/doc/ghc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a></code>s in the <code>zlib</code> format
</p></div></div><h1 id="g:3">Builder compression
</h1><div class="top"><p class="src"><a name="v:gzipBuilder" class="def">gzipBuilder</a> :: <a href="System-IO-Streams-Zlib.html#t:CompressionLevel">CompressionLevel</a> -> <a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a> <a href="/usr/share/doc/ghc/html/libraries/blaze-builder-0.3.1.1/Blaze-ByteString-Builder-Internal-Types.html#t:Builder">Builder</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a> <a href="/usr/share/doc/ghc/html/libraries/blaze-builder-0.3.1.1/Blaze-ByteString-Builder-Internal-Types.html#t:Builder">Builder</a>)<a href="src/System-IO-Streams-Zlib.html#gzipBuilder" class="link">Source</a></p><div class="doc"><p>Convert an <code><a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a></code> that consumes compressed <code><a href="/usr/share/doc/ghc/html/libraries/blaze-builder-0.3.1.1/Blaze-ByteString-Builder-Internal-Types.html#t:Builder">Builder</a></code>s into an
<code><a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a></code> that consumes uncompressed <code><a href="/usr/share/doc/ghc/html/libraries/blaze-builder-0.3.1.1/Blaze-ByteString-Builder-Internal-Types.html#t:Builder">Builder</a></code>s in the <code>gzip</code> format
</p></div></div><div class="top"><p class="src"><a name="v:compressBuilder" class="def">compressBuilder</a> :: <a href="System-IO-Streams-Zlib.html#t:CompressionLevel">CompressionLevel</a> -> <a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a> <a href="/usr/share/doc/ghc/html/libraries/blaze-builder-0.3.1.1/Blaze-ByteString-Builder-Internal-Types.html#t:Builder">Builder</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> (<a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a> <a href="/usr/share/doc/ghc/html/libraries/blaze-builder-0.3.1.1/Blaze-ByteString-Builder-Internal-Types.html#t:Builder">Builder</a>)<a href="src/System-IO-Streams-Zlib.html#compressBuilder" class="link">Source</a></p><div class="doc"><p>Convert an <code><a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a></code> that consumes compressed <code><a href="/usr/share/doc/ghc/html/libraries/blaze-builder-0.3.1.1/Blaze-ByteString-Builder-Internal-Types.html#t:Builder">Builder</a></code>s into an
<code><a href="System-IO-Streams-Internal.html#t:OutputStream">OutputStream</a></code> that consumes uncompressed <code><a href="/usr/share/doc/ghc/html/libraries/blaze-builder-0.3.1.1/Blaze-ByteString-Builder-Internal-Types.html#t:Builder">Builder</a></code>s in the <code>zlib</code> format
</p></div></div><h1 id="g:4">Compression level
</h1><div class="top"><p class="src"><span class="keyword">newtype</span> <a name="t:CompressionLevel" class="def">CompressionLevel</a> <a href="src/System-IO-Streams-Zlib.html#CompressionLevel" class="link">Source</a></p><div class="doc"><p>Parameter that defines the tradeoff between speed and compression ratio
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:CompressionLevel" class="def">CompressionLevel</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.6.0.1/Data-Int.html#t:Int">Int</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:CompressionLevel" class="caption collapser" onclick="toggleSection('i:CompressionLevel')">Instances</p><div id="section.i:CompressionLevel" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.6.0.1/Data-Eq.html#t:Eq">Eq</a> <a href="System-IO-Streams-Zlib.html#t:CompressionLevel">CompressionLevel</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.6.0.1/Prelude.html#t:Num">Num</a> <a href="System-IO-Streams-Zlib.html#t:CompressionLevel">CompressionLevel</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.6.0.1/Text-Read.html#t:Read">Read</a> <a href="System-IO-Streams-Zlib.html#t:CompressionLevel">CompressionLevel</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.6.0.1/Text-Show.html#t:Show">Show</a> <a href="System-IO-Streams-Zlib.html#t:CompressionLevel">CompressionLevel</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:defaultCompressionLevel" class="def">defaultCompressionLevel</a> :: <a href="System-IO-Streams-Zlib.html#t:CompressionLevel">CompressionLevel</a><a href="src/System-IO-Streams-Zlib.html#defaultCompressionLevel" class="link">Source</a></p><div class="doc"><p>A compression level that balances speed with compression ratio
</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>
