/usr/share/doc/libghc-pipes-zlib-doc/html/src/Pipes-Zlib.html is in libghc-pipes-zlib-doc 0.4.0.1-5build1.
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 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://code.haskell.org/~malcolm/hscolour/ -->
<title>src/Pipes/Zlib.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE RankNTypes #-}</span>
<a name="line-2"></a>
<a name="line-3"></a><span class='hs-comment'>-- | This module exports utilities to compress and decompress @pipes@ streams</span>
<a name="line-4"></a><span class='hs-comment'>-- using the zlib compression codec.</span>
<a name="line-5"></a>
<a name="line-6"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Pipes</span><span class='hs-varop'>.</span><span class='hs-conid'>Zlib</span> <span class='hs-layout'>(</span>
<a name="line-7"></a> <span class='hs-comment'>-- * Streams</span>
<a name="line-8"></a> <span class='hs-varid'>decompress</span>
<a name="line-9"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>compress</span>
<a name="line-10"></a>
<a name="line-11"></a> <span class='hs-comment'>-- * Compression level</span>
<a name="line-12"></a> <span class='hs-comment'>-- $ccz-re-export</span>
<a name="line-13"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>ZC</span><span class='hs-varop'>.</span><span class='hs-varid'>defaultCompression</span>
<a name="line-14"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>ZC</span><span class='hs-varop'>.</span><span class='hs-varid'>noCompression</span>
<a name="line-15"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>ZC</span><span class='hs-varop'>.</span><span class='hs-varid'>bestSpeed</span>
<a name="line-16"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>ZC</span><span class='hs-varop'>.</span><span class='hs-varid'>bestCompression</span>
<a name="line-17"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>ZC</span><span class='hs-varop'>.</span><span class='hs-varid'>compressionLevel</span>
<a name="line-18"></a>
<a name="line-19"></a> <span class='hs-comment'>-- * Window size</span>
<a name="line-20"></a> <span class='hs-comment'>-- $ccz-re-export</span>
<a name="line-21"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>ZC</span><span class='hs-varop'>.</span><span class='hs-varid'>defaultWindowBits</span>
<a name="line-22"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>ZC</span><span class='hs-varop'>.</span><span class='hs-varid'>windowBits</span>
<a name="line-23"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-24"></a>
<a name="line-25"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Codec</span><span class='hs-varop'>.</span><span class='hs-conid'>Compression</span><span class='hs-varop'>.</span><span class='hs-conid'>Zlib</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>ZC</span>
<a name="line-26"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Codec</span><span class='hs-varop'>.</span><span class='hs-conid'>Zlib</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>Z</span>
<a name="line-27"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span> <span class='hs-layout'>(</span><span class='hs-varid'>unless</span><span class='hs-layout'>)</span>
<a name="line-28"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>B</span>
<a name="line-29"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Pipes</span>
<a name="line-30"></a>
<a name="line-31"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-32"></a>
<a name="line-33"></a><a name="decompress"></a><span class='hs-comment'>-- | Decompress bytes flowing from a 'Producer'.</span>
<a name="line-34"></a><span class='hs-comment'>--</span>
<a name="line-35"></a><span class='hs-comment'>-- See the "Codec.Compression.Zlib" module for details about 'Z.WindowBits'.</span>
<a name="line-36"></a><span class='hs-definition'>decompress</span>
<a name="line-37"></a> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>MonadIO</span> <span class='hs-varid'>m</span>
<a name="line-38"></a> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>ZC</span><span class='hs-varop'>.</span><span class='hs-conid'>WindowBits</span>
<a name="line-39"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Producer'</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-varid'>m</span> <span class='hs-varid'>r</span> <span class='hs-comment'>-- ^ Compressed stream</span>
<a name="line-40"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Producer'</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-varid'>m</span> <span class='hs-varid'>r</span> <span class='hs-comment'>-- ^ Decompressed stream</span>
<a name="line-41"></a><span class='hs-definition'>decompress</span> <span class='hs-varid'>wbits</span> <span class='hs-varid'>p0</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-42"></a> <span class='hs-varid'>inf</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>liftIO</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Z</span><span class='hs-varop'>.</span><span class='hs-varid'>initInflate</span> <span class='hs-varid'>wbits</span>
<a name="line-43"></a> <span class='hs-varid'>r</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>for</span> <span class='hs-varid'>p0</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>bs</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-44"></a> <span class='hs-varid'>popper</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>liftIO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Z</span><span class='hs-varop'>.</span><span class='hs-varid'>feedInflate</span> <span class='hs-varid'>inf</span> <span class='hs-varid'>bs</span><span class='hs-layout'>)</span>
<a name="line-45"></a> <span class='hs-varid'>fromPopper</span> <span class='hs-varid'>popper</span>
<a name="line-46"></a> <span class='hs-varid'>bs</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>liftIO</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Z</span><span class='hs-varop'>.</span><span class='hs-varid'>finishInflate</span> <span class='hs-varid'>inf</span>
<a name="line-47"></a> <span class='hs-varid'>unless</span> <span class='hs-layout'>(</span><span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-varid'>null</span> <span class='hs-varid'>bs</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>yield</span> <span class='hs-varid'>bs</span><span class='hs-layout'>)</span>
<a name="line-48"></a> <span class='hs-varid'>return</span> <span class='hs-varid'>r</span>
<a name="line-49"></a><span class='hs-comment'>{-# INLINABLE decompress #-}</span>
<a name="line-50"></a>
<a name="line-51"></a>
<a name="line-52"></a><a name="compress"></a><span class='hs-comment'>-- | Compress bytes flowing from a 'Producer'.</span>
<a name="line-53"></a><span class='hs-comment'>--</span>
<a name="line-54"></a><span class='hs-comment'>-- See the "Codec.Compression.Zlib" module for details about</span>
<a name="line-55"></a><span class='hs-comment'>-- 'ZC.CompressionLevel' and 'ZC.WindowBits'.</span>
<a name="line-56"></a><span class='hs-definition'>compress</span>
<a name="line-57"></a> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>MonadIO</span> <span class='hs-varid'>m</span>
<a name="line-58"></a> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>ZC</span><span class='hs-varop'>.</span><span class='hs-conid'>CompressionLevel</span>
<a name="line-59"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ZC</span><span class='hs-varop'>.</span><span class='hs-conid'>WindowBits</span>
<a name="line-60"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Producer'</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-varid'>m</span> <span class='hs-varid'>r</span> <span class='hs-comment'>-- ^ Decompressed stream</span>
<a name="line-61"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Producer'</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-varid'>m</span> <span class='hs-varid'>r</span> <span class='hs-comment'>-- ^ Compressed stream</span>
<a name="line-62"></a><span class='hs-definition'>compress</span> <span class='hs-varid'>clevel</span> <span class='hs-varid'>wbits</span> <span class='hs-varid'>p0</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-63"></a> <span class='hs-varid'>def</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>liftIO</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Z</span><span class='hs-varop'>.</span><span class='hs-varid'>initDeflate</span> <span class='hs-layout'>(</span><span class='hs-varid'>fromCompressionLevel</span> <span class='hs-varid'>clevel</span><span class='hs-layout'>)</span> <span class='hs-varid'>wbits</span>
<a name="line-64"></a> <span class='hs-varid'>r</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>for</span> <span class='hs-varid'>p0</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>bs</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-65"></a> <span class='hs-varid'>popper</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>liftIO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Z</span><span class='hs-varop'>.</span><span class='hs-varid'>feedDeflate</span> <span class='hs-varid'>def</span> <span class='hs-varid'>bs</span><span class='hs-layout'>)</span>
<a name="line-66"></a> <span class='hs-varid'>fromPopper</span> <span class='hs-varid'>popper</span>
<a name="line-67"></a> <span class='hs-varid'>mbs</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>liftIO</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Z</span><span class='hs-varop'>.</span><span class='hs-varid'>finishDeflate</span> <span class='hs-varid'>def</span>
<a name="line-68"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>mbs</span> <span class='hs-keyword'>of</span>
<a name="line-69"></a> <span class='hs-conid'>Just</span> <span class='hs-varid'>bs</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>yield</span> <span class='hs-varid'>bs</span>
<a name="line-70"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-conid'>()</span>
<a name="line-71"></a> <span class='hs-varid'>return</span> <span class='hs-varid'>r</span>
<a name="line-72"></a><span class='hs-comment'>{-# INLINABLE compress #-}</span>
<a name="line-73"></a>
<a name="line-74"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-75"></a>
<a name="line-76"></a><span class='hs-comment'>-- $ccz-re-export</span>
<a name="line-77"></a><span class='hs-comment'>--</span>
<a name="line-78"></a><span class='hs-comment'>-- The following are re-exported from "Codec.Compression.Zlib" for your</span>
<a name="line-79"></a><span class='hs-comment'>-- convenience.</span>
<a name="line-80"></a>
<a name="line-81"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-82"></a><span class='hs-comment'>-- Internal stuff</span>
<a name="line-83"></a>
<a name="line-84"></a><a name="fromPopper"></a><span class='hs-comment'>-- | Produce values from the given 'Z.Popper' until exhausted.</span>
<a name="line-85"></a><span class='hs-definition'>fromPopper</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>MonadIO</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Z</span><span class='hs-varop'>.</span><span class='hs-conid'>Popper</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Producer'</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span>
<a name="line-86"></a><span class='hs-definition'>fromPopper</span> <span class='hs-varid'>pop</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>loop</span> <span class='hs-keyword'>where</span>
<a name="line-87"></a> <span class='hs-varid'>loop</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-88"></a> <span class='hs-varid'>mbs</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>liftIO</span> <span class='hs-varid'>pop</span>
<a name="line-89"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>mbs</span> <span class='hs-keyword'>of</span>
<a name="line-90"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-conid'>()</span>
<a name="line-91"></a> <span class='hs-conid'>Just</span> <span class='hs-varid'>bs</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>yield</span> <span class='hs-varid'>bs</span> <span class='hs-varop'>>></span> <span class='hs-varid'>loop</span>
<a name="line-92"></a><span class='hs-comment'>{-# INLINABLE fromPopper #-}</span>
<a name="line-93"></a>
<a name="line-94"></a><a name="fromCompressionLevel"></a><span class='hs-comment'>-- We need this function until the @zlib@ library hides the</span>
<a name="line-95"></a><span class='hs-comment'>-- 'ZC.CompressionLevel' constructors in future version 0.7.</span>
<a name="line-96"></a><span class='hs-definition'>fromCompressionLevel</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ZC</span><span class='hs-varop'>.</span><span class='hs-conid'>CompressionLevel</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Int</span>
<a name="line-97"></a><span class='hs-definition'>fromCompressionLevel</span> <span class='hs-varid'>level</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>level</span> <span class='hs-keyword'>of</span>
<a name="line-98"></a> <span class='hs-conid'>ZC</span><span class='hs-varop'>.</span><span class='hs-conid'>DefaultCompression</span> <span class='hs-keyglyph'>-></span> <span class='hs-comment'>-</span><span class='hs-num'>1</span>
<a name="line-99"></a> <span class='hs-conid'>ZC</span><span class='hs-varop'>.</span><span class='hs-conid'>NoCompression</span> <span class='hs-keyglyph'>-></span> <span class='hs-num'>0</span>
<a name="line-100"></a> <span class='hs-conid'>ZC</span><span class='hs-varop'>.</span><span class='hs-conid'>BestSpeed</span> <span class='hs-keyglyph'>-></span> <span class='hs-num'>1</span>
<a name="line-101"></a> <span class='hs-conid'>ZC</span><span class='hs-varop'>.</span><span class='hs-conid'>BestCompression</span> <span class='hs-keyglyph'>-></span> <span class='hs-num'>9</span>
<a name="line-102"></a> <span class='hs-conid'>ZC</span><span class='hs-varop'>.</span><span class='hs-conid'>CompressionLevel</span> <span class='hs-varid'>n</span>
<a name="line-103"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>n</span> <span class='hs-varop'>>=</span> <span class='hs-num'>0</span> <span class='hs-varop'>&&</span> <span class='hs-varid'>n</span> <span class='hs-varop'><=</span> <span class='hs-num'>9</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>n</span>
<a name="line-104"></a> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>error</span> <span class='hs-str'>"CompressLevel must be in the range 1..9"</span>
</pre></body>
</html>
|