/usr/share/doc/libghc-zlib-bindings-doc/html/src/Codec-Zlib.html is in libghc-zlib-bindings-doc 0.1.1.1-3build1.
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 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 | <?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>Codec/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 DeriveDataTypeable #-}</span>
<a name="line-2"></a><span class='hs-comment'>-- | This is a middle-level wrapper around the zlib C API. It allows you to</span>
<a name="line-3"></a><span class='hs-comment'>-- work fully with bytestrings and not touch the FFI at all, but is still</span>
<a name="line-4"></a><span class='hs-comment'>-- low-level enough to allow you to implement high-level abstractions such as</span>
<a name="line-5"></a><span class='hs-comment'>-- enumerators. Significantly, it does not use lazy IO.</span>
<a name="line-6"></a><span class='hs-comment'>--</span>
<a name="line-7"></a><span class='hs-comment'>-- You'll probably need to reference the docs a bit to understand the</span>
<a name="line-8"></a><span class='hs-comment'>-- WindowBits parameters below, but a basic rule of thumb is 15 is for zlib</span>
<a name="line-9"></a><span class='hs-comment'>-- compression, and 31 for gzip compression.</span>
<a name="line-10"></a><span class='hs-comment'>--</span>
<a name="line-11"></a><span class='hs-comment'>-- A simple streaming compressor in pseudo-code would look like:</span>
<a name="line-12"></a><span class='hs-comment'>--</span>
<a name="line-13"></a><span class='hs-comment'>-- > def <- initDeflate ...</span>
<a name="line-14"></a><span class='hs-comment'>-- > popper <- feedDeflate def rawContent</span>
<a name="line-15"></a><span class='hs-comment'>-- > pullPopper popper</span>
<a name="line-16"></a><span class='hs-comment'>-- > ...</span>
<a name="line-17"></a><span class='hs-comment'>-- > finishDeflate def sendCompressedData</span>
<a name="line-18"></a><span class='hs-comment'>--</span>
<a name="line-19"></a><span class='hs-comment'>-- You can see a more complete example is available in the included</span>
<a name="line-20"></a><span class='hs-comment'>-- file-test.hs.</span>
<a name="line-21"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Codec</span><span class='hs-varop'>.</span><span class='hs-conid'>Zlib</span>
<a name="line-22"></a> <span class='hs-layout'>(</span> <span class='hs-comment'>-- * Inflate</span>
<a name="line-23"></a> <span class='hs-conid'>Inflate</span>
<a name="line-24"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>initInflate</span>
<a name="line-25"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>initInflateWithDictionary</span>
<a name="line-26"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>feedInflate</span>
<a name="line-27"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>finishInflate</span>
<a name="line-28"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>flushInflate</span>
<a name="line-29"></a> <span class='hs-comment'>-- * Deflate</span>
<a name="line-30"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Deflate</span>
<a name="line-31"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>initDeflate</span>
<a name="line-32"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>initDeflateWithDictionary</span>
<a name="line-33"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>feedDeflate</span>
<a name="line-34"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>finishDeflate</span>
<a name="line-35"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>flushDeflate</span>
<a name="line-36"></a> <span class='hs-comment'>-- * Data types</span>
<a name="line-37"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>WindowBits</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-38"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>defaultWindowBits</span>
<a name="line-39"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>ZlibException</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-40"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Popper</span>
<a name="line-41"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-42"></a>
<a name="line-43"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Codec</span><span class='hs-varop'>.</span><span class='hs-conid'>Zlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Lowlevel</span>
<a name="line-44"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Foreign</span><span class='hs-varop'>.</span><span class='hs-conid'>ForeignPtr</span>
<a name="line-45"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Foreign</span><span class='hs-varop'>.</span><span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span>
<a name="line-46"></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-varop'>.</span><span class='hs-conid'>Unsafe</span>
<a name="line-47"></a><span class='hs-keyword'>import</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-layout'>(</span><span class='hs-conid'>WindowBits</span><span class='hs-layout'>(</span><span class='hs-conid'>WindowBits</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>defaultWindowBits</span><span class='hs-layout'>)</span>
<a name="line-48"></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-49"></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-varop'>.</span><span class='hs-conid'>Lazy</span><span class='hs-varop'>.</span><span class='hs-conid'>Internal</span> <span class='hs-layout'>(</span><span class='hs-varid'>defaultChunkSize</span><span class='hs-layout'>)</span>
<a name="line-50"></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'>when</span><span class='hs-layout'>)</span>
<a name="line-51"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Typeable</span> <span class='hs-layout'>(</span><span class='hs-conid'>Typeable</span><span class='hs-layout'>)</span>
<a name="line-52"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Exception</span> <span class='hs-layout'>(</span><span class='hs-conid'>Exception</span><span class='hs-layout'>,</span> <span class='hs-varid'>throwIO</span><span class='hs-layout'>)</span>
<a name="line-53"></a>
<a name="line-54"></a><a name="ZStreamPair"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>ZStreamPair</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-conid'>ForeignPtr</span> <span class='hs-conid'>ZStreamStruct</span><span class='hs-layout'>,</span> <span class='hs-conid'>ForeignPtr</span> <span class='hs-conid'>CChar</span><span class='hs-layout'>)</span>
<a name="line-55"></a>
<a name="line-56"></a><a name="Inflate"></a><span class='hs-comment'>-- | The state of an inflation (eg, decompression) process. All allocated</span>
<a name="line-57"></a><a name="Inflate"></a><span class='hs-comment'>-- memory is automatically reclaimed by the garbage collector.</span>
<a name="line-58"></a><a name="Inflate"></a><span class='hs-comment'>-- Also can contain the inflation dictionary that is used for decompression.</span>
<a name="line-59"></a><a name="Inflate"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>Inflate</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Inflate</span> <span class='hs-layout'>(</span><span class='hs-conid'>ZStreamPair</span><span class='hs-layout'>,</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span>
<a name="line-60"></a>
<a name="line-61"></a><a name="Deflate"></a><span class='hs-comment'>-- | The state of a deflation (eg, compression) process. All allocated memory</span>
<a name="line-62"></a><a name="Deflate"></a><span class='hs-comment'>-- is automatically reclaimed by the garbage collector.</span>
<a name="line-63"></a><a name="Deflate"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>Deflate</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Deflate</span> <span class='hs-conid'>ZStreamPair</span>
<a name="line-64"></a>
<a name="line-65"></a><span class='hs-comment'>-- | Exception that can be thrown from the FFI code. The parameter is the</span>
<a name="line-66"></a><span class='hs-comment'>-- numerical error code from the zlib library. Quoting the zlib.h file</span>
<a name="line-67"></a><span class='hs-comment'>-- directly:</span>
<a name="line-68"></a><span class='hs-comment'>--</span>
<a name="line-69"></a><span class='hs-comment'>-- * #define Z_OK 0</span>
<a name="line-70"></a><span class='hs-comment'>--</span>
<a name="line-71"></a><span class='hs-comment'>-- * #define Z_STREAM_END 1</span>
<a name="line-72"></a><span class='hs-comment'>--</span>
<a name="line-73"></a><span class='hs-comment'>-- * #define Z_NEED_DICT 2</span>
<a name="line-74"></a><span class='hs-comment'>--</span>
<a name="line-75"></a><span class='hs-comment'>-- * #define Z_ERRNO (-1)</span>
<a name="line-76"></a><span class='hs-comment'>--</span>
<a name="line-77"></a><span class='hs-comment'>-- * #define Z_STREAM_ERROR (-2)</span>
<a name="line-78"></a><span class='hs-comment'>--</span>
<a name="line-79"></a><span class='hs-comment'>-- * #define Z_DATA_ERROR (-3)</span>
<a name="line-80"></a><span class='hs-comment'>--</span>
<a name="line-81"></a><span class='hs-comment'>-- * #define Z_MEM_ERROR (-4)</span>
<a name="line-82"></a><span class='hs-comment'>--</span>
<a name="line-83"></a><span class='hs-comment'>-- * #define Z_BUF_ERROR (-5)</span>
<a name="line-84"></a><span class='hs-comment'>--</span>
<a name="line-85"></a><span class='hs-comment'>-- * #define Z_VERSION_ERROR (-6)</span>
<a name="line-86"></a>
<a name="line-87"></a><a name="ZlibException"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>ZlibException</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ZlibException</span> <span class='hs-conid'>Int</span>
<a name="line-88"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Show</span><span class='hs-layout'>,</span> <span class='hs-conid'>Typeable</span><span class='hs-layout'>)</span>
<a name="line-89"></a><a name="instance%20Exception%20ZlibException%20--%20%7c%20Some%20constants%20for%20the%20error%20codes,%20used%20internally%20zNeedDict%20::%20CInt%20zNeedDict%20=%202%20zBufError%20::%20CInt%20zBufError%20=%20-5%20--%20%7c%20Initialize%20an%20inflation%20process%20with%20the%20given%20'WindowBits'.%20You%20will%20need%20--%20to%20call%20'feedInflate'%20to%20feed%20compressed%20data%20to%20this%20and%20--%20'finishInflate'%20to%20extract%20the%20final%20chunk%20of%20decompressed%20data.%20initInflate%20::%20WindowBits%20-%3e%20IO%20Inflate%20initInflate%20w%20=%20do%20zstr%20%3c-%20zstreamNew%20inflateInit2%20zstr%20w%20fzstr%20%3c-%20newForeignPtr%20c_free_z_stream_inflate%20zstr%20fbuff%20%3c-%20mallocForeignPtrBytes%20defaultChunkSize%20withForeignPtr%20fbuff%20$%20%5cbuff%20-%3e%20c_set_avail_out%20zstr%20buff%20$%20fromIntegral%20defaultChunkSize%20return%20$%20Inflate%20((fzstr,%20fbuff),%20Nothing)%20--%20%7c%20Initialize%20an%20inflation%20process%20with%20the%20given%20'WindowBits'.%20--%20Unlike%20initInflate%20a%20dictionary%20for%20inflation%20is%20set%20which%20must%20--%20match%20the%20one%20set%20during%20compression.%20initInflateWithDictionary%20::%20WindowBits%20-%3e%20S.ByteString%20-%3e%20IO%20Inflate%20initInflateWithDictionary%20w%20bs%20=%20do%20zstr%20%3c-%20zstreamNew%20inflateInit2%20zstr%20w%20fzstr%20%3c-%20newForeignPtr%20c_free_z_stream_inflate%20zstr%20fbuff%20%3c-%20mallocForeignPtrBytes%20defaultChunkSize%20withForeignPtr%20fbuff%20$%20%5cbuff%20-%3e%20c_set_avail_out%20zstr%20buff%20$%20fromIntegral%20defaultChunkSize%20return%20$%20Inflate%20((fzstr,%20fbuff),%20Just%20bs)%20--%20%7c%20Initialize%20a%20deflation%20process%20with%20the%20given%20compression%20level%20and%20--%20'WindowBits'.%20You%20will%20need%20to%20call%20'feedDeflate'%20to%20feed%20uncompressed%20--%20data%20to%20this%20and%20'finishDeflate'%20to%20extract%20the%20final%20chunks%20of%20compressed%20--%20data.%20initDeflate%20::%20Int%20--%20%5e%20Compression%20level%20-%3e%20WindowBits%20-%3e%20IO%20Deflate%20initDeflate%20level%20w%20=%20do%20zstr%20%3c-%20zstreamNew%20deflateInit2%20zstr%20level%20w%208%20StrategyDefault%20fzstr%20%3c-%20newForeignPtr%20c_free_z_stream_deflate%20zstr%20fbuff%20%3c-%20mallocForeignPtrBytes%20defaultChunkSize%20withForeignPtr%20fbuff%20$%20%5cbuff%20-%3e%20c_set_avail_out%20zstr%20buff%20$%20fromIntegral%20defaultChunkSize%20return%20$%20Deflate%20(fzstr,%20fbuff)%20--%20%7c%20Initialize%20an%20deflation%20process%20with%20the%20given%20compression%20level%20and%20--%20'WindowBits'.%20--%20Unlike%20initDeflate%20a%20dictionary%20for%20deflation%20is%20set.%20initDeflateWithDictionary%20::%20Int%20--%20%5e%20Compression%20level%20-%3e%20S.ByteString%20--%20%5e%20Deflate%20dictionary%20-%3e%20WindowBits%20-%3e%20IO%20Deflate%20initDeflateWithDictionary%20level%20bs%20w%20=%20do%20zstr%20%3c-%20zstreamNew%20deflateInit2%20zstr%20level%20w%208%20StrategyDefault%20fzstr%20%3c-%20newForeignPtr%20c_free_z_stream_deflate%20zstr%20fbuff%20%3c-%20mallocForeignPtrBytes%20defaultChunkSize%20unsafeUseAsCStringLen%20bs%20$%20%5c(cstr,%20len)%20-%3e%20do%20c_call_deflate_set_dictionary%20zstr%20cstr%20$%20fromIntegral%20len%20withForeignPtr%20fbuff%20$%20%5cbuff%20-%3e%20c_set_avail_out%20zstr%20buff%20$%20fromIntegral%20defaultChunkSize%20return%20$%20Deflate%20(fzstr,%20fbuff)%20--%20%7c%20Feed%20the%20given%20'S.ByteString'%20to%20the%20inflater.%20This%20function%20takes%20a%20--%20function%20argument%20which%20takes%20a%20%5c%22popper%5c%22.%20A%20popper%20is%20an%20IO%20action%20that%20--%20will%20return%20the%20next%20bit%20of%20inflated%20data,%20returning%20'Nothing'%20when%20there%20is%20--%20no%20more%20data%20to%20be%20popped.%20--%20--%20Note%20that%20this%20function%20automatically%20buffers%20the%20output%20to%20--%20'defaultChunkSize',%20and%20therefore%20you%20won't%20get%20any%20data%20from%20the%20popper%20--%20until%20that%20much%20decompressed%20data%20is%20available.%20After%20you%20have%20fed%20all%20of%20--%20the%20compressed%20data%20to%20this%20function,%20you%20can%20extract%20your%20final%20chunk%20of%20--%20decompressed%20data%20using%20'finishInflate'.%20feedInflate%20::%20Inflate%20-%3e%20S.ByteString%20-%3e%20IO%20Popper%20feedInflate%20(Inflate%20((fzstr,%20fbuff),%20inflateDictionary))%20bs%20=%20do%20withForeignPtr%20fzstr%20$%20%5czstr%20-%3e%20unsafeUseAsCStringLen%20bs%20$%20%5c(cstr,%20len)%20-%3e%20c_set_avail_in%20zstr%20cstr%20$%20fromIntegral%20len%20return%20$%20drain%20fbuff%20fzstr%20(Just%20bs)%20inflate%20False"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Exception</span> <span class='hs-conid'>ZlibException</span>
<a name="line-90"></a>
<a name="line-91"></a><a name="zNeedDict"></a><span class='hs-comment'>-- | Some constants for the error codes, used internally</span>
<a name="line-92"></a><span class='hs-definition'>zNeedDict</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>CInt</span>
<a name="line-93"></a><span class='hs-definition'>zNeedDict</span> <span class='hs-keyglyph'>=</span> <span class='hs-num'>2</span>
<a name="line-94"></a>
<a name="line-95"></a><a name="zBufError"></a><span class='hs-definition'>zBufError</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>CInt</span>
<a name="line-96"></a><span class='hs-definition'>zBufError</span> <span class='hs-keyglyph'>=</span> <span class='hs-comment'>-</span><span class='hs-num'>5</span>
<a name="line-97"></a>
<a name="line-98"></a><a name="initInflate"></a><span class='hs-comment'>-- | Initialize an inflation process with the given 'WindowBits'. You will need</span>
<a name="line-99"></a><span class='hs-comment'>-- to call 'feedInflate' to feed compressed data to this and</span>
<a name="line-100"></a><span class='hs-comment'>-- 'finishInflate' to extract the final chunk of decompressed data.</span>
<a name="line-101"></a><span class='hs-definition'>initInflate</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>WindowBits</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Inflate</span>
<a name="line-102"></a><span class='hs-definition'>initInflate</span> <span class='hs-varid'>w</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-103"></a> <span class='hs-varid'>zstr</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>zstreamNew</span>
<a name="line-104"></a> <span class='hs-varid'>inflateInit2</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>w</span>
<a name="line-105"></a> <span class='hs-varid'>fzstr</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>newForeignPtr</span> <span class='hs-varid'>c_free_z_stream_inflate</span> <span class='hs-varid'>zstr</span>
<a name="line-106"></a> <span class='hs-varid'>fbuff</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>mallocForeignPtrBytes</span> <span class='hs-varid'>defaultChunkSize</span>
<a name="line-107"></a> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>fbuff</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>buff</span> <span class='hs-keyglyph'>-></span>
<a name="line-108"></a> <span class='hs-varid'>c_set_avail_out</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>buff</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>defaultChunkSize</span>
<a name="line-109"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Inflate</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varid'>fzstr</span><span class='hs-layout'>,</span> <span class='hs-varid'>fbuff</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>Nothing</span><span class='hs-layout'>)</span>
<a name="line-110"></a>
<a name="line-111"></a><a name="initInflateWithDictionary"></a><span class='hs-comment'>-- | Initialize an inflation process with the given 'WindowBits'. </span>
<a name="line-112"></a><span class='hs-comment'>-- Unlike initInflate a dictionary for inflation is set which must</span>
<a name="line-113"></a><span class='hs-comment'>-- match the one set during compression.</span>
<a name="line-114"></a><span class='hs-definition'>initInflateWithDictionary</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>WindowBits</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Inflate</span>
<a name="line-115"></a><span class='hs-definition'>initInflateWithDictionary</span> <span class='hs-varid'>w</span> <span class='hs-varid'>bs</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-116"></a> <span class='hs-varid'>zstr</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>zstreamNew</span>
<a name="line-117"></a> <span class='hs-varid'>inflateInit2</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>w</span>
<a name="line-118"></a> <span class='hs-varid'>fzstr</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>newForeignPtr</span> <span class='hs-varid'>c_free_z_stream_inflate</span> <span class='hs-varid'>zstr</span>
<a name="line-119"></a> <span class='hs-varid'>fbuff</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>mallocForeignPtrBytes</span> <span class='hs-varid'>defaultChunkSize</span>
<a name="line-120"></a>
<a name="line-121"></a> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>fbuff</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>buff</span> <span class='hs-keyglyph'>-></span>
<a name="line-122"></a> <span class='hs-varid'>c_set_avail_out</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>buff</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>defaultChunkSize</span>
<a name="line-123"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Inflate</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varid'>fzstr</span><span class='hs-layout'>,</span> <span class='hs-varid'>fbuff</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>Just</span> <span class='hs-varid'>bs</span><span class='hs-layout'>)</span>
<a name="line-124"></a>
<a name="line-125"></a><a name="initDeflate"></a><span class='hs-comment'>-- | Initialize a deflation process with the given compression level and</span>
<a name="line-126"></a><span class='hs-comment'>-- 'WindowBits'. You will need to call 'feedDeflate' to feed uncompressed</span>
<a name="line-127"></a><span class='hs-comment'>-- data to this and 'finishDeflate' to extract the final chunks of compressed</span>
<a name="line-128"></a><span class='hs-comment'>-- data.</span>
<a name="line-129"></a><span class='hs-definition'>initDeflate</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span> <span class='hs-comment'>-- ^ Compression level</span>
<a name="line-130"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>WindowBits</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Deflate</span>
<a name="line-131"></a><span class='hs-definition'>initDeflate</span> <span class='hs-varid'>level</span> <span class='hs-varid'>w</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-132"></a> <span class='hs-varid'>zstr</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>zstreamNew</span>
<a name="line-133"></a> <span class='hs-varid'>deflateInit2</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>level</span> <span class='hs-varid'>w</span> <span class='hs-num'>8</span> <span class='hs-conid'>StrategyDefault</span>
<a name="line-134"></a> <span class='hs-varid'>fzstr</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>newForeignPtr</span> <span class='hs-varid'>c_free_z_stream_deflate</span> <span class='hs-varid'>zstr</span>
<a name="line-135"></a> <span class='hs-varid'>fbuff</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>mallocForeignPtrBytes</span> <span class='hs-varid'>defaultChunkSize</span>
<a name="line-136"></a> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>fbuff</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>buff</span> <span class='hs-keyglyph'>-></span>
<a name="line-137"></a> <span class='hs-varid'>c_set_avail_out</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>buff</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>defaultChunkSize</span>
<a name="line-138"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Deflate</span> <span class='hs-layout'>(</span><span class='hs-varid'>fzstr</span><span class='hs-layout'>,</span> <span class='hs-varid'>fbuff</span><span class='hs-layout'>)</span>
<a name="line-139"></a>
<a name="line-140"></a><a name="initDeflateWithDictionary"></a><span class='hs-comment'>-- | Initialize an deflation process with the given compression level and</span>
<a name="line-141"></a><span class='hs-comment'>-- 'WindowBits'.</span>
<a name="line-142"></a><span class='hs-comment'>-- Unlike initDeflate a dictionary for deflation is set.</span>
<a name="line-143"></a><span class='hs-definition'>initDeflateWithDictionary</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span> <span class='hs-comment'>-- ^ Compression level</span>
<a name="line-144"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-comment'>-- ^ Deflate dictionary</span>
<a name="line-145"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>WindowBits</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Deflate</span>
<a name="line-146"></a><span class='hs-definition'>initDeflateWithDictionary</span> <span class='hs-varid'>level</span> <span class='hs-varid'>bs</span> <span class='hs-varid'>w</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-147"></a> <span class='hs-varid'>zstr</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>zstreamNew</span>
<a name="line-148"></a> <span class='hs-varid'>deflateInit2</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>level</span> <span class='hs-varid'>w</span> <span class='hs-num'>8</span> <span class='hs-conid'>StrategyDefault</span>
<a name="line-149"></a> <span class='hs-varid'>fzstr</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>newForeignPtr</span> <span class='hs-varid'>c_free_z_stream_deflate</span> <span class='hs-varid'>zstr</span>
<a name="line-150"></a> <span class='hs-varid'>fbuff</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>mallocForeignPtrBytes</span> <span class='hs-varid'>defaultChunkSize</span>
<a name="line-151"></a>
<a name="line-152"></a> <span class='hs-varid'>unsafeUseAsCStringLen</span> <span class='hs-varid'>bs</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-varid'>cstr</span><span class='hs-layout'>,</span> <span class='hs-varid'>len</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-153"></a> <span class='hs-varid'>c_call_deflate_set_dictionary</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>cstr</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>len</span>
<a name="line-154"></a>
<a name="line-155"></a> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>fbuff</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>buff</span> <span class='hs-keyglyph'>-></span>
<a name="line-156"></a> <span class='hs-varid'>c_set_avail_out</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>buff</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>defaultChunkSize</span>
<a name="line-157"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Deflate</span> <span class='hs-layout'>(</span><span class='hs-varid'>fzstr</span><span class='hs-layout'>,</span> <span class='hs-varid'>fbuff</span><span class='hs-layout'>)</span>
<a name="line-158"></a>
<a name="line-159"></a><a name="feedInflate"></a><span class='hs-comment'>-- | Feed the given 'S.ByteString' to the inflater. This function takes a</span>
<a name="line-160"></a><span class='hs-comment'>-- function argument which takes a \"popper\". A popper is an IO action that</span>
<a name="line-161"></a><span class='hs-comment'>-- will return the next bit of inflated data, returning 'Nothing' when there is</span>
<a name="line-162"></a><span class='hs-comment'>-- no more data to be popped.</span>
<a name="line-163"></a><span class='hs-comment'>--</span>
<a name="line-164"></a><span class='hs-comment'>-- Note that this function automatically buffers the output to</span>
<a name="line-165"></a><span class='hs-comment'>-- 'defaultChunkSize', and therefore you won't get any data from the popper</span>
<a name="line-166"></a><span class='hs-comment'>-- until that much decompressed data is available. After you have fed all of</span>
<a name="line-167"></a><span class='hs-comment'>-- the compressed data to this function, you can extract your final chunk of</span>
<a name="line-168"></a><span class='hs-comment'>-- decompressed data using 'finishInflate'.</span>
<a name="line-169"></a><span class='hs-definition'>feedInflate</span>
<a name="line-170"></a> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Inflate</span>
<a name="line-171"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span>
<a name="line-172"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Popper</span>
<a name="line-173"></a><span class='hs-definition'>feedInflate</span> <span class='hs-layout'>(</span><span class='hs-conid'>Inflate</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varid'>fzstr</span><span class='hs-layout'>,</span> <span class='hs-varid'>fbuff</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>inflateDictionary</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varid'>bs</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-174"></a> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>fzstr</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>zstr</span> <span class='hs-keyglyph'>-></span>
<a name="line-175"></a> <span class='hs-varid'>unsafeUseAsCStringLen</span> <span class='hs-varid'>bs</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-varid'>cstr</span><span class='hs-layout'>,</span> <span class='hs-varid'>len</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span>
<a name="line-176"></a> <span class='hs-varid'>c_set_avail_in</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>cstr</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>len</span>
<a name="line-177"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>drain</span> <span class='hs-varid'>fbuff</span> <span class='hs-varid'>fzstr</span> <span class='hs-layout'>(</span><span class='hs-conid'>Just</span> <span class='hs-varid'>bs</span><span class='hs-layout'>)</span> <span class='hs-varid'>inflate</span> <span class='hs-conid'>False</span>
<a name="line-178"></a> <span class='hs-keyword'>where</span>
<a name="line-179"></a> <span class='hs-varid'>inflate</span> <span class='hs-varid'>zstr</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-180"></a> <span class='hs-varid'>res</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>c_call_inflate_noflush</span> <span class='hs-varid'>zstr</span>
<a name="line-181"></a> <span class='hs-keyword'>if</span> <span class='hs-layout'>(</span><span class='hs-varid'>res</span> <span class='hs-varop'>==</span> <span class='hs-varid'>zNeedDict</span><span class='hs-layout'>)</span>
<a name="line-182"></a> <span class='hs-keyword'>then</span> <span class='hs-varid'>maybe</span> <span class='hs-layout'>(</span><span class='hs-varid'>throwIO</span> <span class='hs-varop'>$</span> <span class='hs-conid'>ZlibException</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>zNeedDict</span><span class='hs-layout'>)</span> <span class='hs-comment'>-- no dictionary supplied so throw error</span>
<a name="line-183"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>dict</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-varid'>unsafeUseAsCStringLen</span> <span class='hs-varid'>dict</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-varid'>cstr</span><span class='hs-layout'>,</span> <span class='hs-varid'>len</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-184"></a> <span class='hs-varid'>c_call_inflate_set_dictionary</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>cstr</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>len</span>
<a name="line-185"></a> <span class='hs-varid'>c_call_inflate_noflush</span> <span class='hs-varid'>zstr</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-186"></a> <span class='hs-varid'>inflateDictionary</span>
<a name="line-187"></a> <span class='hs-keyword'>else</span> <span class='hs-varid'>return</span> <span class='hs-varid'>res</span>
<a name="line-188"></a>
<a name="line-189"></a><a name="Popper"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>Popper</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span>
<a name="line-190"></a>
<a name="line-191"></a><a name="keepAlive"></a><span class='hs-comment'>-- | Ensure that the given @ByteString@ is not deallocated.</span>
<a name="line-192"></a><span class='hs-definition'>keepAlive</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</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-conid'>IO</span> <span class='hs-varid'>a</span>
<a name="line-193"></a><span class='hs-definition'>keepAlive</span> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>id</span>
<a name="line-194"></a><span class='hs-definition'>keepAlive</span> <span class='hs-layout'>(</span><span class='hs-conid'>Just</span> <span class='hs-varid'>bs</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>unsafeUseAsCStringLen</span> <span class='hs-varid'>bs</span> <span class='hs-varop'>.</span> <span class='hs-varid'>const</span>
<a name="line-195"></a>
<a name="line-196"></a><a name="drain"></a><span class='hs-definition'>drain</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ForeignPtr</span> <span class='hs-conid'>CChar</span>
<a name="line-197"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ForeignPtr</span> <span class='hs-conid'>ZStreamStruct</span>
<a name="line-198"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span>
<a name="line-199"></a> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>ZStream'</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>CInt</span><span class='hs-layout'>)</span>
<a name="line-200"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Bool</span>
<a name="line-201"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Popper</span>
<a name="line-202"></a><span class='hs-definition'>drain</span> <span class='hs-varid'>fbuff</span> <span class='hs-varid'>fzstr</span> <span class='hs-varid'>mbs</span> <span class='hs-varid'>func</span> <span class='hs-varid'>isFinish</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>fzstr</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>zstr</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>keepAlive</span> <span class='hs-varid'>mbs</span> <span class='hs-varop'>$</span> <span class='hs-keyword'>do</span>
<a name="line-203"></a> <span class='hs-varid'>a</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>c_get_avail_in</span> <span class='hs-varid'>zstr</span>
<a name="line-204"></a> <span class='hs-keyword'>if</span> <span class='hs-varid'>a</span> <span class='hs-varop'>==</span> <span class='hs-num'>0</span> <span class='hs-varop'>&&</span> <span class='hs-varid'>not</span> <span class='hs-varid'>isFinish</span>
<a name="line-205"></a> <span class='hs-keyword'>then</span> <span class='hs-varid'>return</span> <span class='hs-conid'>Nothing</span>
<a name="line-206"></a> <span class='hs-keyword'>else</span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>fbuff</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>buff</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-207"></a> <span class='hs-varid'>res</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>func</span> <span class='hs-varid'>zstr</span>
<a name="line-208"></a> <span class='hs-varid'>when</span> <span class='hs-layout'>(</span><span class='hs-varid'>res</span> <span class='hs-varop'><</span> <span class='hs-num'>0</span> <span class='hs-varop'>&&</span> <span class='hs-varid'>res</span> <span class='hs-varop'>/=</span> <span class='hs-varid'>zBufError</span><span class='hs-layout'>)</span>
<a name="line-209"></a> <span class='hs-varop'>$</span> <span class='hs-varid'>throwIO</span> <span class='hs-varop'>$</span> <span class='hs-conid'>ZlibException</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>res</span>
<a name="line-210"></a> <span class='hs-varid'>avail</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>c_get_avail_out</span> <span class='hs-varid'>zstr</span>
<a name="line-211"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>size</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>defaultChunkSize</span> <span class='hs-comment'>-</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>avail</span>
<a name="line-212"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>toOutput</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>avail</span> <span class='hs-varop'>==</span> <span class='hs-num'>0</span> <span class='hs-varop'>||</span> <span class='hs-layout'>(</span><span class='hs-varid'>isFinish</span> <span class='hs-varop'>&&</span> <span class='hs-varid'>size</span> <span class='hs-varop'>/=</span> <span class='hs-num'>0</span><span class='hs-layout'>)</span>
<a name="line-213"></a> <span class='hs-keyword'>if</span> <span class='hs-varid'>toOutput</span>
<a name="line-214"></a> <span class='hs-keyword'>then</span> <span class='hs-keyword'>do</span>
<a name="line-215"></a> <span class='hs-varid'>bs</span> <span class='hs-keyglyph'><-</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-varid'>packCStringLen</span> <span class='hs-layout'>(</span><span class='hs-varid'>buff</span><span class='hs-layout'>,</span> <span class='hs-varid'>size</span><span class='hs-layout'>)</span>
<a name="line-216"></a> <span class='hs-varid'>c_set_avail_out</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>buff</span>
<a name="line-217"></a> <span class='hs-varop'>$</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>defaultChunkSize</span>
<a name="line-218"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Just</span> <span class='hs-varid'>bs</span>
<a name="line-219"></a> <span class='hs-keyword'>else</span> <span class='hs-varid'>return</span> <span class='hs-conid'>Nothing</span>
<a name="line-220"></a>
<a name="line-221"></a>
<a name="line-222"></a><a name="finishInflate"></a><span class='hs-comment'>-- | As explained in 'feedInflate', inflation buffers your decompressed</span>
<a name="line-223"></a><span class='hs-comment'>-- data. After you call 'feedInflate' with your last chunk of compressed</span>
<a name="line-224"></a><span class='hs-comment'>-- data, you will likely have some data still sitting in the buffer. This</span>
<a name="line-225"></a><span class='hs-comment'>-- function will return it to you.</span>
<a name="line-226"></a><span class='hs-definition'>finishInflate</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Inflate</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span>
<a name="line-227"></a><span class='hs-definition'>finishInflate</span> <span class='hs-layout'>(</span><span class='hs-conid'>Inflate</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varid'>fzstr</span><span class='hs-layout'>,</span> <span class='hs-varid'>fbuff</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span>
<a name="line-228"></a> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>fzstr</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>zstr</span> <span class='hs-keyglyph'>-></span>
<a name="line-229"></a> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>fbuff</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>buff</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-230"></a> <span class='hs-varid'>avail</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>c_get_avail_out</span> <span class='hs-varid'>zstr</span>
<a name="line-231"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>size</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>defaultChunkSize</span> <span class='hs-comment'>-</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>avail</span>
<a name="line-232"></a> <span class='hs-varid'>bs</span> <span class='hs-keyglyph'><-</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-varid'>packCStringLen</span> <span class='hs-layout'>(</span><span class='hs-varid'>buff</span><span class='hs-layout'>,</span> <span class='hs-varid'>size</span><span class='hs-layout'>)</span>
<a name="line-233"></a> <span class='hs-varid'>c_set_avail_out</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>buff</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>defaultChunkSize</span>
<a name="line-234"></a> <span class='hs-varid'>return</span> <span class='hs-varid'>bs</span>
<a name="line-235"></a>
<a name="line-236"></a><a name="flushInflate"></a><span class='hs-comment'>-- | Flush the inflation buffer. Useful for interactive application.</span>
<a name="line-237"></a><span class='hs-comment'>--</span>
<a name="line-238"></a><span class='hs-comment'>-- This is actually a synonym for 'finishInflate'. It is provided for its more</span>
<a name="line-239"></a><span class='hs-comment'>-- semantic name.</span>
<a name="line-240"></a><span class='hs-comment'>--</span>
<a name="line-241"></a><span class='hs-comment'>-- Since 0.0.3</span>
<a name="line-242"></a><span class='hs-definition'>flushInflate</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Inflate</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span>
<a name="line-243"></a><span class='hs-definition'>flushInflate</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>finishInflate</span>
<a name="line-244"></a>
<a name="line-245"></a><a name="feedDeflate"></a><span class='hs-comment'>-- | Feed the given 'S.ByteString' to the deflater. This function takes a</span>
<a name="line-246"></a><span class='hs-comment'>-- function argument which takes a \"popper\". A popper is an IO action that</span>
<a name="line-247"></a><span class='hs-comment'>-- will return the next bit of deflated data, returning 'Nothing' when there is</span>
<a name="line-248"></a><span class='hs-comment'>-- no more data to be popped.</span>
<a name="line-249"></a><span class='hs-comment'>--</span>
<a name="line-250"></a><span class='hs-comment'>-- Note that this function automatically buffers the output to</span>
<a name="line-251"></a><span class='hs-comment'>-- 'defaultChunkSize', and therefore you won't get any data from the popper</span>
<a name="line-252"></a><span class='hs-comment'>-- until that much compressed data is available. After you have fed all of the</span>
<a name="line-253"></a><span class='hs-comment'>-- decompressed data to this function, you can extract your final chunks of</span>
<a name="line-254"></a><span class='hs-comment'>-- compressed data using 'finishDeflate'.</span>
<a name="line-255"></a><span class='hs-definition'>feedDeflate</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Deflate</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Popper</span>
<a name="line-256"></a><span class='hs-definition'>feedDeflate</span> <span class='hs-layout'>(</span><span class='hs-conid'>Deflate</span> <span class='hs-layout'>(</span><span class='hs-varid'>fzstr</span><span class='hs-layout'>,</span> <span class='hs-varid'>fbuff</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varid'>bs</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-257"></a> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>fzstr</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>zstr</span> <span class='hs-keyglyph'>-></span>
<a name="line-258"></a> <span class='hs-varid'>unsafeUseAsCStringLen</span> <span class='hs-varid'>bs</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-varid'>cstr</span><span class='hs-layout'>,</span> <span class='hs-varid'>len</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-259"></a> <span class='hs-varid'>c_set_avail_in</span> <span class='hs-varid'>zstr</span> <span class='hs-varid'>cstr</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>len</span>
<a name="line-260"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>drain</span> <span class='hs-varid'>fbuff</span> <span class='hs-varid'>fzstr</span> <span class='hs-layout'>(</span><span class='hs-conid'>Just</span> <span class='hs-varid'>bs</span><span class='hs-layout'>)</span> <span class='hs-varid'>c_call_deflate_noflush</span> <span class='hs-conid'>False</span>
<a name="line-261"></a>
<a name="line-262"></a><a name="finishDeflate"></a><span class='hs-comment'>-- | As explained in 'feedDeflate', deflation buffers your compressed</span>
<a name="line-263"></a><span class='hs-comment'>-- data. After you call 'feedDeflate' with your last chunk of uncompressed</span>
<a name="line-264"></a><span class='hs-comment'>-- data, we need to flush the rest of the data waiting to be deflated. This</span>
<a name="line-265"></a><span class='hs-comment'>-- function takes a function parameter which accepts a \"popper\", just like</span>
<a name="line-266"></a><span class='hs-comment'>-- 'feedDeflate'.</span>
<a name="line-267"></a><span class='hs-definition'>finishDeflate</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Deflate</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Popper</span>
<a name="line-268"></a><span class='hs-definition'>finishDeflate</span> <span class='hs-layout'>(</span><span class='hs-conid'>Deflate</span> <span class='hs-layout'>(</span><span class='hs-varid'>fzstr</span><span class='hs-layout'>,</span> <span class='hs-varid'>fbuff</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span>
<a name="line-269"></a> <span class='hs-varid'>drain</span> <span class='hs-varid'>fbuff</span> <span class='hs-varid'>fzstr</span> <span class='hs-conid'>Nothing</span> <span class='hs-varid'>c_call_deflate_finish</span> <span class='hs-conid'>True</span>
<a name="line-270"></a>
<a name="line-271"></a><a name="flushDeflate"></a><span class='hs-comment'>-- | Flush the deflation buffer. Useful for interactive application.</span>
<a name="line-272"></a><span class='hs-comment'>--</span>
<a name="line-273"></a><span class='hs-comment'>-- Internally this passes Z_SYNC_FLUSH to the zlib library.</span>
<a name="line-274"></a><span class='hs-comment'>--</span>
<a name="line-275"></a><span class='hs-comment'>-- Since 0.0.3</span>
<a name="line-276"></a><span class='hs-definition'>flushDeflate</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Deflate</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Popper</span>
<a name="line-277"></a><span class='hs-definition'>flushDeflate</span> <span class='hs-layout'>(</span><span class='hs-conid'>Deflate</span> <span class='hs-layout'>(</span><span class='hs-varid'>fzstr</span><span class='hs-layout'>,</span> <span class='hs-varid'>fbuff</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span>
<a name="line-278"></a> <span class='hs-varid'>drain</span> <span class='hs-varid'>fbuff</span> <span class='hs-varid'>fzstr</span> <span class='hs-conid'>Nothing</span> <span class='hs-varid'>c_call_deflate_flush</span> <span class='hs-conid'>True</span>
</pre></body>
</html>
|