/usr/share/doc/libghc-conduit-extra-doc/html/src/Data-Conduit-Zlib.html is in libghc-conduit-extra-doc 1.1.13.3-3.
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 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 | <?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>Data/Conduit/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 FlexibleContexts #-}</span>
<a name="line-2"></a><span class='hs-comment'>{-# LANGUAGE RankNTypes #-}</span>
<a name="line-3"></a><span class='hs-comment'>-- | Streaming compression and decompression using conduits.</span>
<a name="line-4"></a><span class='hs-comment'>--</span>
<a name="line-5"></a><span class='hs-comment'>-- Parts of this code were taken from zlib-enum and adapted for conduits.</span>
<a name="line-6"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Conduit</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'>-- * Conduits</span>
<a name="line-8"></a> <span class='hs-varid'>compress</span><span class='hs-layout'>,</span> <span class='hs-varid'>decompress</span><span class='hs-layout'>,</span> <span class='hs-varid'>gzip</span><span class='hs-layout'>,</span> <span class='hs-varid'>ungzip</span><span class='hs-layout'>,</span>
<a name="line-9"></a> <span class='hs-comment'>-- * Flushing</span>
<a name="line-10"></a> <span class='hs-varid'>compressFlush</span><span class='hs-layout'>,</span> <span class='hs-varid'>decompressFlush</span><span class='hs-layout'>,</span>
<a name="line-11"></a> <span class='hs-comment'>-- * Decompression combinators</span>
<a name="line-12"></a> <span class='hs-varid'>multiple</span><span class='hs-layout'>,</span>
<a name="line-13"></a> <span class='hs-comment'>-- * Re-exported from zlib-bindings</span>
<a name="line-14"></a> <span class='hs-conid'>WindowBits</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>defaultWindowBits</span>
<a name="line-15"></a><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-16"></a>
<a name="line-17"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Streaming</span><span class='hs-varop'>.</span><span class='hs-conid'>Zlib</span>
<a name="line-18"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Conduit</span>
<a name="line-19"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-layout'>(</span><span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span>
<a name="line-20"></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'>S</span>
<a name="line-21"></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> <span class='hs-varid'>liftM</span><span class='hs-layout'>)</span>
<a name="line-22"></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-varop'>.</span><span class='hs-conid'>Trans</span><span class='hs-varop'>.</span><span class='hs-conid'>Class</span> <span class='hs-layout'>(</span><span class='hs-varid'>lift</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadTrans</span><span class='hs-layout'>)</span>
<a name="line-23"></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-varop'>.</span><span class='hs-conid'>Primitive</span> <span class='hs-layout'>(</span><span class='hs-conid'>PrimMonad</span><span class='hs-layout'>,</span> <span class='hs-varid'>unsafePrimToPrim</span><span class='hs-layout'>)</span>
<a name="line-24"></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-varop'>.</span><span class='hs-conid'>Base</span> <span class='hs-layout'>(</span><span class='hs-conid'>MonadBase</span><span class='hs-layout'>,</span> <span class='hs-varid'>liftBase</span><span class='hs-layout'>)</span>
<a name="line-25"></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-varop'>.</span><span class='hs-conid'>Trans</span><span class='hs-varop'>.</span><span class='hs-conid'>Resource</span> <span class='hs-layout'>(</span><span class='hs-conid'>MonadThrow</span><span class='hs-layout'>,</span> <span class='hs-varid'>monadThrow</span><span class='hs-layout'>)</span>
<a name="line-26"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Function</span> <span class='hs-layout'>(</span><span class='hs-varid'>fix</span><span class='hs-layout'>)</span>
<a name="line-27"></a>
<a name="line-28"></a><a name="gzip"></a><span class='hs-comment'>-- | Gzip compression with default parameters.</span>
<a name="line-29"></a><span class='hs-definition'>gzip</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>MonadThrow</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadBase</span> <span class='hs-varid'>base</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>PrimMonad</span> <span class='hs-varid'>base</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Conduit</span> <span class='hs-conid'>ByteString</span> <span class='hs-varid'>m</span> <span class='hs-conid'>ByteString</span>
<a name="line-30"></a><span class='hs-definition'>gzip</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>compress</span> <span class='hs-num'>1</span> <span class='hs-layout'>(</span><span class='hs-conid'>WindowBits</span> <span class='hs-num'>31</span><span class='hs-layout'>)</span>
<a name="line-31"></a>
<a name="line-32"></a><a name="ungzip"></a><span class='hs-comment'>-- | Gzip decompression with default parameters.</span>
<a name="line-33"></a><span class='hs-definition'>ungzip</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>MonadBase</span> <span class='hs-varid'>base</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>PrimMonad</span> <span class='hs-varid'>base</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadThrow</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Conduit</span> <span class='hs-conid'>ByteString</span> <span class='hs-varid'>m</span> <span class='hs-conid'>ByteString</span>
<a name="line-34"></a><span class='hs-definition'>ungzip</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>decompress</span> <span class='hs-layout'>(</span><span class='hs-conid'>WindowBits</span> <span class='hs-num'>31</span><span class='hs-layout'>)</span>
<a name="line-35"></a>
<a name="line-36"></a><a name="unsafeLiftIO"></a><span class='hs-definition'>unsafeLiftIO</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>MonadBase</span> <span class='hs-varid'>base</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>PrimMonad</span> <span class='hs-varid'>base</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadThrow</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>a</span>
<a name="line-37"></a><span class='hs-definition'>unsafeLiftIO</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>liftBase</span> <span class='hs-varop'>.</span> <span class='hs-varid'>unsafePrimToPrim</span>
<a name="line-38"></a>
<a name="line-39"></a><span class='hs-comment'>-- |</span>
<a name="line-40"></a><span class='hs-comment'>-- Decompress (inflate) a stream of 'ByteString's. For example:</span>
<a name="line-41"></a><span class='hs-comment'>--</span>
<a name="line-42"></a><span class='hs-comment'>-- > sourceFile "test.z" $= decompress defaultWindowBits $$ sinkFile "test"</span>
<a name="line-43"></a>
<a name="line-44"></a><a name="decompress"></a><span class='hs-definition'>decompress</span>
<a name="line-45"></a> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>MonadBase</span> <span class='hs-varid'>base</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>PrimMonad</span> <span class='hs-varid'>base</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadThrow</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span>
<a name="line-46"></a> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>WindowBits</span> <span class='hs-comment'>-- ^ Zlib parameter (see the zlib-bindings package as well as the zlib C library)</span>
<a name="line-47"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Conduit</span> <span class='hs-conid'>ByteString</span> <span class='hs-varid'>m</span> <span class='hs-conid'>ByteString</span>
<a name="line-48"></a><span class='hs-definition'>decompress</span> <span class='hs-keyglyph'>=</span>
<a name="line-49"></a> <span class='hs-varid'>helperDecompress</span> <span class='hs-layout'>(</span><span class='hs-varid'>liftM</span> <span class='hs-layout'>(</span><span class='hs-varid'>fmap</span> <span class='hs-conid'>Chunk</span><span class='hs-layout'>)</span> <span class='hs-varid'>await</span><span class='hs-layout'>)</span> <span class='hs-varid'>yield'</span> <span class='hs-varid'>leftover</span>
<a name="line-50"></a> <span class='hs-keyword'>where</span>
<a name="line-51"></a> <span class='hs-varid'>yield'</span> <span class='hs-conid'>Flush</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-conid'>()</span>
<a name="line-52"></a> <span class='hs-varid'>yield'</span> <span class='hs-layout'>(</span><span class='hs-conid'>Chunk</span> <span class='hs-varid'>bs</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>yield</span> <span class='hs-varid'>bs</span>
<a name="line-53"></a>
<a name="line-54"></a><a name="decompressFlush"></a><span class='hs-comment'>-- | Same as 'decompress', but allows you to explicitly flush the stream.</span>
<a name="line-55"></a><span class='hs-definition'>decompressFlush</span>
<a name="line-56"></a> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>MonadBase</span> <span class='hs-varid'>base</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>PrimMonad</span> <span class='hs-varid'>base</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadThrow</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span>
<a name="line-57"></a> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>WindowBits</span> <span class='hs-comment'>-- ^ Zlib parameter (see the zlib-bindings package as well as the zlib C library)</span>
<a name="line-58"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Conduit</span> <span class='hs-layout'>(</span><span class='hs-conid'>Flush</span> <span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span> <span class='hs-varid'>m</span> <span class='hs-layout'>(</span><span class='hs-conid'>Flush</span> <span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span>
<a name="line-59"></a><span class='hs-definition'>decompressFlush</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>helperDecompress</span> <span class='hs-varid'>await</span> <span class='hs-varid'>yield</span> <span class='hs-layout'>(</span><span class='hs-varid'>leftover</span> <span class='hs-varop'>.</span> <span class='hs-conid'>Chunk</span><span class='hs-layout'>)</span>
<a name="line-60"></a>
<a name="line-61"></a><a name="helperDecompress"></a><span class='hs-definition'>helperDecompress</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Monad</span> <span class='hs-layout'>(</span><span class='hs-varid'>t</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadBase</span> <span class='hs-varid'>base</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>PrimMonad</span> <span class='hs-varid'>base</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadThrow</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadTrans</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span>
<a name="line-62"></a> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>t</span> <span class='hs-varid'>m</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-layout'>(</span><span class='hs-conid'>Flush</span> <span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-63"></a> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>Flush</span> <span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>t</span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
<a name="line-64"></a> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>t</span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
<a name="line-65"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>WindowBits</span>
<a name="line-66"></a> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>t</span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span>
<a name="line-67"></a><span class='hs-definition'>helperDecompress</span> <span class='hs-varid'>await'</span> <span class='hs-varid'>yield'</span> <span class='hs-varid'>leftover'</span> <span class='hs-varid'>config</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-68"></a> <span class='hs-comment'>-- Initialize the stateful inflater, which will be used below</span>
<a name="line-69"></a> <span class='hs-comment'>-- This inflater is never exposed outside of this function</span>
<a name="line-70"></a> <span class='hs-varid'>inf</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>lift</span> <span class='hs-varop'>$</span> <span class='hs-varid'>unsafeLiftIO</span> <span class='hs-varop'>$</span> <span class='hs-varid'>initInflate</span> <span class='hs-varid'>config</span>
<a name="line-71"></a>
<a name="line-72"></a> <span class='hs-comment'>-- Some helper functions used by the main feeder loop below</span>
<a name="line-73"></a>
<a name="line-74"></a> <span class='hs-keyword'>let</span> <span class='hs-comment'>-- Flush any remaining inflated bytes downstream</span>
<a name="line-75"></a> <span class='hs-varid'>flush</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-76"></a> <span class='hs-varid'>chunk</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>lift</span> <span class='hs-varop'>$</span> <span class='hs-varid'>unsafeLiftIO</span> <span class='hs-varop'>$</span> <span class='hs-varid'>flushInflate</span> <span class='hs-varid'>inf</span>
<a name="line-77"></a> <span class='hs-varid'>unless</span> <span class='hs-layout'>(</span><span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-varid'>null</span> <span class='hs-varid'>chunk</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-varid'>yield'</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Chunk</span> <span class='hs-varid'>chunk</span>
<a name="line-78"></a>
<a name="line-79"></a> <span class='hs-comment'>-- Get any input which is unused by the inflater</span>
<a name="line-80"></a> <span class='hs-varid'>getUnused</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>lift</span> <span class='hs-varop'>$</span> <span class='hs-varid'>unsafeLiftIO</span> <span class='hs-varop'>$</span> <span class='hs-varid'>getUnusedInflate</span> <span class='hs-varid'>inf</span>
<a name="line-81"></a>
<a name="line-82"></a> <span class='hs-comment'>-- If there is any unused data, return it as leftovers to the stream</span>
<a name="line-83"></a> <span class='hs-varid'>unused</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-84"></a> <span class='hs-varid'>rem'</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getUnused</span>
<a name="line-85"></a> <span class='hs-varid'>unless</span> <span class='hs-layout'>(</span><span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-varid'>null</span> <span class='hs-varid'>rem'</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-varid'>leftover'</span> <span class='hs-varid'>rem'</span>
<a name="line-86"></a>
<a name="line-87"></a> <span class='hs-comment'>-- Main loop: feed data from upstream into the inflater</span>
<a name="line-88"></a> <span class='hs-varid'>fix</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>feeder</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-89"></a> <span class='hs-varid'>mnext</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>await'</span>
<a name="line-90"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>mnext</span> <span class='hs-keyword'>of</span>
<a name="line-91"></a> <span class='hs-comment'>-- No more data is available from upstream</span>
<a name="line-92"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-93"></a> <span class='hs-comment'>-- Flush any remaining uncompressed data</span>
<a name="line-94"></a> <span class='hs-varid'>flush</span>
<a name="line-95"></a> <span class='hs-comment'>-- Return the rest of the unconsumed data as leftovers</span>
<a name="line-96"></a> <span class='hs-varid'>unused</span>
<a name="line-97"></a> <span class='hs-comment'>-- Another chunk of compressed data arrived</span>
<a name="line-98"></a> <span class='hs-conid'>Just</span> <span class='hs-layout'>(</span><span class='hs-conid'>Chunk</span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-99"></a> <span class='hs-comment'>-- Feed the compressed data into the inflater, returning a</span>
<a name="line-100"></a> <span class='hs-comment'>-- "popper" which will return chunks of decompressed data</span>
<a name="line-101"></a> <span class='hs-varid'>popper</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>lift</span> <span class='hs-varop'>$</span> <span class='hs-varid'>unsafeLiftIO</span> <span class='hs-varop'>$</span> <span class='hs-varid'>feedInflate</span> <span class='hs-varid'>inf</span> <span class='hs-varid'>x</span>
<a name="line-102"></a>
<a name="line-103"></a> <span class='hs-comment'>-- Loop over the popper grabbing decompressed chunks and</span>
<a name="line-104"></a> <span class='hs-comment'>-- yielding them downstream</span>
<a name="line-105"></a> <span class='hs-varid'>fix</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>pop</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-106"></a> <span class='hs-varid'>mbs</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>lift</span> <span class='hs-varop'>$</span> <span class='hs-varid'>unsafeLiftIO</span> <span class='hs-varid'>popper</span>
<a name="line-107"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>mbs</span> <span class='hs-keyword'>of</span>
<a name="line-108"></a> <span class='hs-comment'>-- No more data from this popper</span>
<a name="line-109"></a> <span class='hs-conid'>PRDone</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-110"></a> <span class='hs-varid'>rem'</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getUnused</span>
<a name="line-111"></a> <span class='hs-keyword'>if</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-varid'>null</span> <span class='hs-varid'>rem'</span>
<a name="line-112"></a> <span class='hs-comment'>-- No data was unused by the inflater, so let's</span>
<a name="line-113"></a> <span class='hs-comment'>-- fill it up again and get more data out of it</span>
<a name="line-114"></a> <span class='hs-keyword'>then</span> <span class='hs-varid'>feeder</span>
<a name="line-115"></a> <span class='hs-comment'>-- In this case, there is some unconsumed data,</span>
<a name="line-116"></a> <span class='hs-comment'>-- meaning the compressed stream is complete.</span>
<a name="line-117"></a> <span class='hs-comment'>-- At this point, we need to stop feeding,</span>
<a name="line-118"></a> <span class='hs-comment'>-- return the unconsumed data as leftovers, and</span>
<a name="line-119"></a> <span class='hs-comment'>-- flush any remaining content (which should be</span>
<a name="line-120"></a> <span class='hs-comment'>-- nothing)</span>
<a name="line-121"></a> <span class='hs-keyword'>else</span> <span class='hs-keyword'>do</span>
<a name="line-122"></a> <span class='hs-varid'>flush</span>
<a name="line-123"></a> <span class='hs-varid'>leftover'</span> <span class='hs-varid'>rem'</span>
<a name="line-124"></a> <span class='hs-comment'>-- Another chunk available, yield it downstream and</span>
<a name="line-125"></a> <span class='hs-comment'>-- loop again</span>
<a name="line-126"></a> <span class='hs-conid'>PRNext</span> <span class='hs-varid'>bs</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-127"></a> <span class='hs-varid'>yield'</span> <span class='hs-layout'>(</span><span class='hs-conid'>Chunk</span> <span class='hs-varid'>bs</span><span class='hs-layout'>)</span>
<a name="line-128"></a> <span class='hs-varid'>pop</span>
<a name="line-129"></a> <span class='hs-comment'>-- An error occurred inside zlib, throw it</span>
<a name="line-130"></a> <span class='hs-conid'>PRError</span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>lift</span> <span class='hs-varop'>$</span> <span class='hs-varid'>monadThrow</span> <span class='hs-varid'>e</span>
<a name="line-131"></a> <span class='hs-comment'>-- We've been asked to flush the stream</span>
<a name="line-132"></a> <span class='hs-conid'>Just</span> <span class='hs-conid'>Flush</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-133"></a> <span class='hs-comment'>-- Get any uncompressed data waiting for us</span>
<a name="line-134"></a> <span class='hs-varid'>flush</span>
<a name="line-135"></a> <span class='hs-comment'>-- Put a Flush in the stream</span>
<a name="line-136"></a> <span class='hs-varid'>yield'</span> <span class='hs-conid'>Flush</span>
<a name="line-137"></a> <span class='hs-comment'>-- Feed in more data</span>
<a name="line-138"></a> <span class='hs-varid'>feeder</span>
<a name="line-139"></a>
<a name="line-140"></a><span class='hs-comment'>-- |</span>
<a name="line-141"></a><span class='hs-comment'>-- Compress (deflate) a stream of 'ByteString's. The 'WindowBits' also control</span>
<a name="line-142"></a><span class='hs-comment'>-- the format (zlib vs. gzip).</span>
<a name="line-143"></a>
<a name="line-144"></a><a name="compress"></a><span class='hs-definition'>compress</span>
<a name="line-145"></a> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>MonadBase</span> <span class='hs-varid'>base</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>PrimMonad</span> <span class='hs-varid'>base</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadThrow</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span>
<a name="line-146"></a> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Int</span> <span class='hs-comment'>-- ^ Compression level</span>
<a name="line-147"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>WindowBits</span> <span class='hs-comment'>-- ^ Zlib parameter (see the zlib-bindings package as well as the zlib C library)</span>
<a name="line-148"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Conduit</span> <span class='hs-conid'>ByteString</span> <span class='hs-varid'>m</span> <span class='hs-conid'>ByteString</span>
<a name="line-149"></a><span class='hs-definition'>compress</span> <span class='hs-keyglyph'>=</span>
<a name="line-150"></a> <span class='hs-varid'>helperCompress</span> <span class='hs-layout'>(</span><span class='hs-varid'>liftM</span> <span class='hs-layout'>(</span><span class='hs-varid'>fmap</span> <span class='hs-conid'>Chunk</span><span class='hs-layout'>)</span> <span class='hs-varid'>await</span><span class='hs-layout'>)</span> <span class='hs-varid'>yield'</span>
<a name="line-151"></a> <span class='hs-keyword'>where</span>
<a name="line-152"></a> <span class='hs-varid'>yield'</span> <span class='hs-conid'>Flush</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-conid'>()</span>
<a name="line-153"></a> <span class='hs-varid'>yield'</span> <span class='hs-layout'>(</span><span class='hs-conid'>Chunk</span> <span class='hs-varid'>bs</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>yield</span> <span class='hs-varid'>bs</span>
<a name="line-154"></a>
<a name="line-155"></a><a name="compressFlush"></a><span class='hs-comment'>-- | Same as 'compress', but allows you to explicitly flush the stream.</span>
<a name="line-156"></a><span class='hs-definition'>compressFlush</span>
<a name="line-157"></a> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>MonadBase</span> <span class='hs-varid'>base</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>PrimMonad</span> <span class='hs-varid'>base</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadThrow</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span>
<a name="line-158"></a> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Int</span> <span class='hs-comment'>-- ^ Compression level</span>
<a name="line-159"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>WindowBits</span> <span class='hs-comment'>-- ^ Zlib parameter (see the zlib-bindings package as well as the zlib C library)</span>
<a name="line-160"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Conduit</span> <span class='hs-layout'>(</span><span class='hs-conid'>Flush</span> <span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span> <span class='hs-varid'>m</span> <span class='hs-layout'>(</span><span class='hs-conid'>Flush</span> <span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span>
<a name="line-161"></a><span class='hs-definition'>compressFlush</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>helperCompress</span> <span class='hs-varid'>await</span> <span class='hs-varid'>yield</span>
<a name="line-162"></a>
<a name="line-163"></a><a name="helperCompress"></a><span class='hs-definition'>helperCompress</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Monad</span> <span class='hs-layout'>(</span><span class='hs-varid'>t</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadBase</span> <span class='hs-varid'>base</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>PrimMonad</span> <span class='hs-varid'>base</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadThrow</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadTrans</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span>
<a name="line-164"></a> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>t</span> <span class='hs-varid'>m</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-layout'>(</span><span class='hs-conid'>Flush</span> <span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-165"></a> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>Flush</span> <span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>t</span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
<a name="line-166"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Int</span>
<a name="line-167"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>WindowBits</span>
<a name="line-168"></a> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>t</span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span>
<a name="line-169"></a><span class='hs-definition'>helperCompress</span> <span class='hs-varid'>await'</span> <span class='hs-varid'>yield'</span> <span class='hs-varid'>level</span> <span class='hs-varid'>config</span> <span class='hs-keyglyph'>=</span>
<a name="line-170"></a> <span class='hs-varid'>await'</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>maybe</span> <span class='hs-layout'>(</span><span class='hs-varid'>return</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span> <span class='hs-varid'>start</span>
<a name="line-171"></a> <span class='hs-keyword'>where</span>
<a name="line-172"></a> <span class='hs-varid'>start</span> <span class='hs-varid'>input</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-173"></a> <span class='hs-varid'>def</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>lift</span> <span class='hs-varop'>$</span> <span class='hs-varid'>unsafeLiftIO</span> <span class='hs-varop'>$</span> <span class='hs-varid'>initDeflate</span> <span class='hs-varid'>level</span> <span class='hs-varid'>config</span>
<a name="line-174"></a> <span class='hs-varid'>push</span> <span class='hs-varid'>def</span> <span class='hs-varid'>input</span>
<a name="line-175"></a>
<a name="line-176"></a> <span class='hs-varid'>continue</span> <span class='hs-varid'>def</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>await'</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>maybe</span> <span class='hs-layout'>(</span><span class='hs-varid'>close</span> <span class='hs-varid'>def</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>push</span> <span class='hs-varid'>def</span><span class='hs-layout'>)</span>
<a name="line-177"></a>
<a name="line-178"></a> <span class='hs-varid'>goPopper</span> <span class='hs-varid'>popper</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-179"></a> <span class='hs-varid'>mbs</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>lift</span> <span class='hs-varop'>$</span> <span class='hs-varid'>unsafeLiftIO</span> <span class='hs-varid'>popper</span>
<a name="line-180"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>mbs</span> <span class='hs-keyword'>of</span>
<a name="line-181"></a> <span class='hs-conid'>PRDone</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-conid'>()</span>
<a name="line-182"></a> <span class='hs-conid'>PRNext</span> <span class='hs-varid'>bs</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>yield'</span> <span class='hs-layout'>(</span><span class='hs-conid'>Chunk</span> <span class='hs-varid'>bs</span><span class='hs-layout'>)</span> <span class='hs-varop'>>></span> <span class='hs-varid'>goPopper</span> <span class='hs-varid'>popper</span>
<a name="line-183"></a> <span class='hs-conid'>PRError</span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>lift</span> <span class='hs-varop'>$</span> <span class='hs-varid'>monadThrow</span> <span class='hs-varid'>e</span>
<a name="line-184"></a>
<a name="line-185"></a> <span class='hs-varid'>push</span> <span class='hs-varid'>def</span> <span class='hs-layout'>(</span><span class='hs-conid'>Chunk</span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-186"></a> <span class='hs-varid'>popper</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>lift</span> <span class='hs-varop'>$</span> <span class='hs-varid'>unsafeLiftIO</span> <span class='hs-varop'>$</span> <span class='hs-varid'>feedDeflate</span> <span class='hs-varid'>def</span> <span class='hs-varid'>x</span>
<a name="line-187"></a> <span class='hs-varid'>goPopper</span> <span class='hs-varid'>popper</span>
<a name="line-188"></a> <span class='hs-varid'>continue</span> <span class='hs-varid'>def</span>
<a name="line-189"></a>
<a name="line-190"></a> <span class='hs-varid'>push</span> <span class='hs-varid'>def</span> <span class='hs-conid'>Flush</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-191"></a> <span class='hs-varid'>mchunk</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>lift</span> <span class='hs-varop'>$</span> <span class='hs-varid'>unsafeLiftIO</span> <span class='hs-varop'>$</span> <span class='hs-varid'>flushDeflate</span> <span class='hs-varid'>def</span>
<a name="line-192"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>mchunk</span> <span class='hs-keyword'>of</span>
<a name="line-193"></a> <span class='hs-conid'>PRDone</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-conid'>()</span>
<a name="line-194"></a> <span class='hs-conid'>PRNext</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>yield'</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Chunk</span> <span class='hs-varid'>x</span>
<a name="line-195"></a> <span class='hs-conid'>PRError</span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>lift</span> <span class='hs-varop'>$</span> <span class='hs-varid'>monadThrow</span> <span class='hs-varid'>e</span>
<a name="line-196"></a> <span class='hs-varid'>yield'</span> <span class='hs-conid'>Flush</span>
<a name="line-197"></a> <span class='hs-varid'>continue</span> <span class='hs-varid'>def</span>
<a name="line-198"></a>
<a name="line-199"></a> <span class='hs-varid'>close</span> <span class='hs-varid'>def</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-200"></a> <span class='hs-varid'>mchunk</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>lift</span> <span class='hs-varop'>$</span> <span class='hs-varid'>unsafeLiftIO</span> <span class='hs-varop'>$</span> <span class='hs-varid'>finishDeflate</span> <span class='hs-varid'>def</span>
<a name="line-201"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>mchunk</span> <span class='hs-keyword'>of</span>
<a name="line-202"></a> <span class='hs-conid'>PRDone</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-conid'>()</span>
<a name="line-203"></a> <span class='hs-conid'>PRNext</span> <span class='hs-varid'>chunk</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>yield'</span> <span class='hs-layout'>(</span><span class='hs-conid'>Chunk</span> <span class='hs-varid'>chunk</span><span class='hs-layout'>)</span> <span class='hs-varop'>>></span> <span class='hs-varid'>close</span> <span class='hs-varid'>def</span>
<a name="line-204"></a> <span class='hs-conid'>PRError</span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>lift</span> <span class='hs-varop'>$</span> <span class='hs-varid'>monadThrow</span> <span class='hs-varid'>e</span>
<a name="line-205"></a>
<a name="line-206"></a><a name="multiple"></a><span class='hs-comment'>-- | The standard 'decompress' and 'ungzip' functions will only decompress a</span>
<a name="line-207"></a><span class='hs-comment'>-- single compressed entity from the stream. This combinator will exhaust the</span>
<a name="line-208"></a><span class='hs-comment'>-- stream completely of all individual compressed entities. This is useful for</span>
<a name="line-209"></a><span class='hs-comment'>-- cases where you have a concatenated archive, e.g. @cat file1.gz file2.gz ></span>
<a name="line-210"></a><span class='hs-comment'>-- combined.gz@.</span>
<a name="line-211"></a><span class='hs-comment'>--</span>
<a name="line-212"></a><span class='hs-comment'>-- Usage:</span>
<a name="line-213"></a><span class='hs-comment'>--</span>
<a name="line-214"></a><span class='hs-comment'>-- > sourceFile "combined.gz" $$ multiple ungzip =$ consume</span>
<a name="line-215"></a><span class='hs-comment'>--</span>
<a name="line-216"></a><span class='hs-comment'>-- This combinator will not fail on an empty stream. If you want to ensure that</span>
<a name="line-217"></a><span class='hs-comment'>-- at least one compressed entity in the stream exists, consider a usage such</span>
<a name="line-218"></a><span class='hs-comment'>-- as:</span>
<a name="line-219"></a><span class='hs-comment'>--</span>
<a name="line-220"></a><span class='hs-comment'>-- > sourceFile "combined.gz" $$ (ungzip >> multiple ungzip) =$ consume</span>
<a name="line-221"></a><span class='hs-comment'>--</span>
<a name="line-222"></a><span class='hs-comment'>-- @since 1.1.10</span>
<a name="line-223"></a><span class='hs-definition'>multiple</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Monad</span> <span class='hs-varid'>m</span>
<a name="line-224"></a> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Conduit</span> <span class='hs-conid'>ByteString</span> <span class='hs-varid'>m</span> <span class='hs-varid'>a</span>
<a name="line-225"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Conduit</span> <span class='hs-conid'>ByteString</span> <span class='hs-varid'>m</span> <span class='hs-varid'>a</span>
<a name="line-226"></a><span class='hs-definition'>multiple</span> <span class='hs-varid'>inner</span> <span class='hs-keyglyph'>=</span>
<a name="line-227"></a> <span class='hs-varid'>loop</span>
<a name="line-228"></a> <span class='hs-keyword'>where</span>
<a name="line-229"></a> <span class='hs-varid'>loop</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-230"></a> <span class='hs-varid'>mbs</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>await</span>
<a name="line-231"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>mbs</span> <span class='hs-keyword'>of</span>
<a name="line-232"></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-233"></a> <span class='hs-conid'>Just</span> <span class='hs-varid'>bs</span>
<a name="line-234"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-varid'>null</span> <span class='hs-varid'>bs</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>loop</span>
<a name="line-235"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-236"></a> <span class='hs-varid'>leftover</span> <span class='hs-varid'>bs</span>
<a name="line-237"></a> <span class='hs-varid'>inner</span>
<a name="line-238"></a> <span class='hs-varid'>loop</span>
</pre></body>
</html>
|