/usr/share/doc/libghc-streaming-commons-doc/html/src/Data-Streaming-ByteString-Builder.html is in libghc-streaming-commons-doc 0.1.17-1build3.
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 | <?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/Streaming/ByteString/Builder.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE CPP #-}</span>
<a name="line-2"></a><span class='hs-comment'>{-# LANGUAGE FlexibleContexts #-}</span>
<a name="line-3"></a><span class='hs-comment'>{-# LANGUAGE BangPatterns #-}</span>
<a name="line-4"></a><span class='hs-comment'>{-# LANGUAGE RankNTypes #-}</span>
<a name="line-5"></a>
<a name="line-6"></a><span class='hs-comment'>-- | Convert a stream of bytestring @Builder@s into a stream of @ByteString@s.</span>
<a name="line-7"></a><span class='hs-comment'>--</span>
<a name="line-8"></a><span class='hs-comment'>-- Adapted from blaze-builder-enumerator, written by Michael Snoyman and Simon Meier.</span>
<a name="line-9"></a><span class='hs-comment'>--</span>
<a name="line-10"></a><span class='hs-comment'>-- Note that the functions here can work in any monad built on top of @IO@ or</span>
<a name="line-11"></a><span class='hs-comment'>-- @ST@.</span>
<a name="line-12"></a><span class='hs-comment'>--</span>
<a name="line-13"></a><span class='hs-comment'>-- Also provides @toByteStringIO*@ like "Blaze.ByteString.Builder"s, for</span>
<a name="line-14"></a><span class='hs-comment'>-- "Data.ByteString.Builder".</span>
<a name="line-15"></a><span class='hs-comment'>--</span>
<a name="line-16"></a><span class='hs-comment'>-- Since 0.1.9</span>
<a name="line-17"></a><span class='hs-comment'>--</span>
<a name="line-18"></a><span class='hs-keyword'>module</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'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Builder</span>
<a name="line-19"></a> <span class='hs-layout'>(</span> <span class='hs-conid'>BuilderRecv</span>
<a name="line-20"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>BuilderPopper</span>
<a name="line-21"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>BuilderFinish</span>
<a name="line-22"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>newByteStringBuilderRecv</span>
<a name="line-23"></a>
<a name="line-24"></a> <span class='hs-comment'>-- * toByteStringIO</span>
<a name="line-25"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>toByteStringIO</span>
<a name="line-26"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>toByteStringIOWith</span>
<a name="line-27"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>toByteStringIOWithBuffer</span>
<a name="line-28"></a>
<a name="line-29"></a> <span class='hs-comment'>-- * Buffers</span>
<a name="line-30"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Buffer</span>
<a name="line-31"></a>
<a name="line-32"></a> <span class='hs-comment'>-- ** Status information</span>
<a name="line-33"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>freeSize</span>
<a name="line-34"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>sliceSize</span>
<a name="line-35"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>bufferSize</span>
<a name="line-36"></a>
<a name="line-37"></a> <span class='hs-comment'>-- ** Creation and modification</span>
<a name="line-38"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>allocBuffer</span>
<a name="line-39"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>reuseBuffer</span>
<a name="line-40"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>nextSlice</span>
<a name="line-41"></a>
<a name="line-42"></a> <span class='hs-comment'>-- ** Conversion to bytestings</span>
<a name="line-43"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>unsafeFreezeBuffer</span>
<a name="line-44"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>unsafeFreezeNonEmptyBuffer</span>
<a name="line-45"></a>
<a name="line-46"></a> <span class='hs-comment'>-- * Buffer allocation strategies</span>
<a name="line-47"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>BufferAllocStrategy</span>
<a name="line-48"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>allNewBuffersStrategy</span>
<a name="line-49"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>reuseBufferStrategy</span>
<a name="line-50"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>defaultStrategy</span>
<a name="line-51"></a> <span class='hs-layout'>)</span>
<a name="line-52"></a> <span class='hs-keyword'>where</span>
<a name="line-53"></a>
<a name="line-54"></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><span class='hs-varid'>unless</span><span class='hs-layout'>)</span>
<a name="line-55"></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-56"></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'>Builder</span> <span class='hs-layout'>(</span><span class='hs-conid'>Builder</span><span class='hs-layout'>)</span>
<a name="line-57"></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'>Builder</span><span class='hs-varop'>.</span><span class='hs-conid'>Extra</span> <span class='hs-layout'>(</span><span class='hs-varid'>runBuilder</span><span class='hs-layout'>,</span> <span class='hs-conid'>BufferWriter</span><span class='hs-layout'>,</span> <span class='hs-conid'>Next</span><span class='hs-layout'>(</span><span class='hs-conid'>Done</span><span class='hs-layout'>,</span> <span class='hs-conid'>More</span><span class='hs-layout'>,</span> <span class='hs-conid'>Chunk</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-58"></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'>Internal</span> <span class='hs-layout'>(</span><span class='hs-varid'>mallocByteString</span><span class='hs-layout'>,</span> <span class='hs-conid'>ByteString</span><span class='hs-layout'>(</span><span class='hs-conid'>PS</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-59"></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-60"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>IORef</span> <span class='hs-layout'>(</span><span class='hs-varid'>newIORef</span><span class='hs-layout'>,</span> <span class='hs-varid'>writeIORef</span><span class='hs-layout'>,</span> <span class='hs-varid'>readIORef</span><span class='hs-layout'>)</span>
<a name="line-61"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Word</span> <span class='hs-layout'>(</span><span class='hs-conid'>Word8</span><span class='hs-layout'>)</span>
<a name="line-62"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Foreign</span><span class='hs-varop'>.</span><span class='hs-conid'>ForeignPtr</span> <span class='hs-layout'>(</span><span class='hs-conid'>ForeignPtr</span><span class='hs-layout'>,</span> <span class='hs-varid'>withForeignPtr</span><span class='hs-layout'>)</span>
<a name="line-63"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Foreign</span><span class='hs-varop'>.</span><span class='hs-conid'>Ptr</span> <span class='hs-layout'>(</span><span class='hs-varid'>plusPtr</span><span class='hs-layout'>,</span> <span class='hs-varid'>minusPtr</span><span class='hs-layout'>)</span>
<a name="line-64"></a>
<a name="line-65"></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'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Builder</span><span class='hs-varop'>.</span><span class='hs-conid'>Buffer</span>
<a name="line-66"></a>
<a name="line-67"></a><a name="BuilderPopper"></a><span class='hs-comment'>-- | Provides a series of @ByteString@s until empty, at which point it provides</span>
<a name="line-68"></a><a name="BuilderPopper"></a><span class='hs-comment'>-- an empty @ByteString@.</span>
<a name="line-69"></a><a name="BuilderPopper"></a><span class='hs-comment'>--</span>
<a name="line-70"></a><a name="BuilderPopper"></a><span class='hs-comment'>-- Since 0.1.10.0</span>
<a name="line-71"></a><a name="BuilderPopper"></a><span class='hs-comment'>--</span>
<a name="line-72"></a><a name="BuilderPopper"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>BuilderPopper</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-73"></a>
<a name="line-74"></a><a name="BuilderRecv"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>BuilderRecv</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Builder</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>BuilderPopper</span>
<a name="line-75"></a>
<a name="line-76"></a><a name="BuilderFinish"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>BuilderFinish</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-77"></a>
<a name="line-78"></a><a name="newByteStringBuilderRecv"></a><span class='hs-definition'>newByteStringBuilderRecv</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>BufferAllocStrategy</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>BuilderRecv</span><span class='hs-layout'>,</span> <span class='hs-conid'>BuilderFinish</span><span class='hs-layout'>)</span>
<a name="line-79"></a><span class='hs-definition'>newByteStringBuilderRecv</span> <span class='hs-layout'>(</span><span class='hs-varid'>ioBufInit</span><span class='hs-layout'>,</span> <span class='hs-varid'>nextBuf</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-80"></a> <span class='hs-varid'>refBuf</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>newIORef</span> <span class='hs-varid'>ioBufInit</span>
<a name="line-81"></a> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>push</span> <span class='hs-varid'>refBuf</span><span class='hs-layout'>,</span> <span class='hs-varid'>finish</span> <span class='hs-varid'>refBuf</span><span class='hs-layout'>)</span>
<a name="line-82"></a> <span class='hs-keyword'>where</span>
<a name="line-83"></a> <span class='hs-varid'>finish</span> <span class='hs-varid'>refBuf</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-84"></a> <span class='hs-varid'>ioBuf</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>readIORef</span> <span class='hs-varid'>refBuf</span>
<a name="line-85"></a> <span class='hs-varid'>buf</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>ioBuf</span>
<a name="line-86"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>unsafeFreezeNonEmptyBuffer</span> <span class='hs-varid'>buf</span>
<a name="line-87"></a>
<a name="line-88"></a> <span class='hs-varid'>push</span> <span class='hs-varid'>refBuf</span> <span class='hs-varid'>builder</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-89"></a> <span class='hs-varid'>refWri</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>newIORef</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Left</span> <span class='hs-varop'>$</span> <span class='hs-varid'>runBuilder</span> <span class='hs-varid'>builder</span>
<a name="line-90"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>popper</span> <span class='hs-varid'>refBuf</span> <span class='hs-varid'>refWri</span>
<a name="line-91"></a>
<a name="line-92"></a> <span class='hs-varid'>popper</span> <span class='hs-varid'>refBuf</span> <span class='hs-varid'>refWri</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-93"></a> <span class='hs-varid'>ioBuf</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>readIORef</span> <span class='hs-varid'>refBuf</span>
<a name="line-94"></a> <span class='hs-varid'>ebWri</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>readIORef</span> <span class='hs-varid'>refWri</span>
<a name="line-95"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>ebWri</span> <span class='hs-keyword'>of</span>
<a name="line-96"></a> <span class='hs-conid'>Left</span> <span class='hs-varid'>bWri</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-97"></a> <span class='hs-varop'>!</span><span class='hs-varid'>buf</span><span class='hs-keyglyph'>@</span><span class='hs-layout'>(</span><span class='hs-conid'>Buffer</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>op</span> <span class='hs-varid'>ope</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>ioBuf</span>
<a name="line-98"></a> <span class='hs-layout'>(</span><span class='hs-varid'>bytes</span><span class='hs-layout'>,</span> <span class='hs-varid'>next</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>bWri</span> <span class='hs-varid'>op</span> <span class='hs-layout'>(</span><span class='hs-varid'>ope</span> <span class='hs-varop'>`minusPtr`</span> <span class='hs-varid'>op</span><span class='hs-layout'>)</span>
<a name="line-99"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>op'</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>op</span> <span class='hs-varop'>`plusPtr`</span> <span class='hs-varid'>bytes</span>
<a name="line-100"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>next</span> <span class='hs-keyword'>of</span>
<a name="line-101"></a> <span class='hs-conid'>Done</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-102"></a> <span class='hs-varid'>writeIORef</span> <span class='hs-varid'>refBuf</span> <span class='hs-varop'>$</span> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>updateEndOfSlice</span> <span class='hs-varid'>buf</span> <span class='hs-varid'>op'</span>
<a name="line-103"></a> <span class='hs-varid'>return</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-varid'>empty</span>
<a name="line-104"></a> <span class='hs-conid'>More</span> <span class='hs-varid'>minSize</span> <span class='hs-varid'>bWri'</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-105"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>buf'</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>updateEndOfSlice</span> <span class='hs-varid'>buf</span> <span class='hs-varid'>op'</span>
<a name="line-106"></a> <span class='hs-comment'>{-# INLINE cont #-}</span>
<a name="line-107"></a> <span class='hs-varid'>cont</span> <span class='hs-varid'>mbs</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-108"></a> <span class='hs-comment'>-- sequencing the computation of the next buffer</span>
<a name="line-109"></a> <span class='hs-comment'>-- construction here ensures that the reference to the</span>
<a name="line-110"></a> <span class='hs-comment'>-- foreign pointer `fp` is lost as soon as possible.</span>
<a name="line-111"></a> <span class='hs-varid'>ioBuf'</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>nextBuf</span> <span class='hs-varid'>minSize</span> <span class='hs-varid'>buf'</span>
<a name="line-112"></a> <span class='hs-varid'>writeIORef</span> <span class='hs-varid'>refBuf</span> <span class='hs-varid'>ioBuf'</span>
<a name="line-113"></a> <span class='hs-varid'>writeIORef</span> <span class='hs-varid'>refWri</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Left</span> <span class='hs-varid'>bWri'</span>
<a name="line-114"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>mbs</span> <span class='hs-keyword'>of</span>
<a name="line-115"></a> <span class='hs-conid'>Just</span> <span class='hs-varid'>bs</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>not</span> <span class='hs-varop'>$</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'>return</span> <span class='hs-varid'>bs</span>
<a name="line-116"></a> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>popper</span> <span class='hs-varid'>refBuf</span> <span class='hs-varid'>refWri</span>
<a name="line-117"></a> <span class='hs-varid'>cont</span> <span class='hs-varop'>$</span> <span class='hs-varid'>unsafeFreezeNonEmptyBuffer</span> <span class='hs-varid'>buf'</span>
<a name="line-118"></a> <span class='hs-conid'>Chunk</span> <span class='hs-varid'>bs</span> <span class='hs-varid'>bWri'</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-119"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>buf'</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>updateEndOfSlice</span> <span class='hs-varid'>buf</span> <span class='hs-varid'>op'</span>
<a name="line-120"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>yieldBS</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-121"></a> <span class='hs-varid'>nextBuf</span> <span class='hs-num'>1</span> <span class='hs-varid'>buf'</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>writeIORef</span> <span class='hs-varid'>refBuf</span>
<a name="line-122"></a> <span class='hs-varid'>writeIORef</span> <span class='hs-varid'>refWri</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Left</span> <span class='hs-varid'>bWri'</span>
<a name="line-123"></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'>bs</span>
<a name="line-124"></a> <span class='hs-keyword'>then</span> <span class='hs-varid'>popper</span> <span class='hs-varid'>refBuf</span> <span class='hs-varid'>refWri</span>
<a name="line-125"></a> <span class='hs-keyword'>else</span> <span class='hs-varid'>return</span> <span class='hs-varid'>bs</span>
<a name="line-126"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>unsafeFreezeNonEmptyBuffer</span> <span class='hs-varid'>buf'</span> <span class='hs-keyword'>of</span>
<a name="line-127"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>yieldBS</span>
<a name="line-128"></a> <span class='hs-conid'>Just</span> <span class='hs-varid'>bs'</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-129"></a> <span class='hs-varid'>writeIORef</span> <span class='hs-varid'>refWri</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Right</span> <span class='hs-varid'>yieldBS</span>
<a name="line-130"></a> <span class='hs-varid'>return</span> <span class='hs-varid'>bs'</span>
<a name="line-131"></a> <span class='hs-conid'>Right</span> <span class='hs-varid'>action</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>action</span>
<a name="line-132"></a>
<a name="line-133"></a><a name="toByteStringIOWithBuffer"></a><span class='hs-comment'>-- | Use a pre-existing buffer to 'toByteStringIOWith'.</span>
<a name="line-134"></a><span class='hs-comment'>--</span>
<a name="line-135"></a><span class='hs-comment'>-- Since 0.1.9</span>
<a name="line-136"></a><span class='hs-comment'>--</span>
<a name="line-137"></a><span class='hs-definition'>toByteStringIOWithBuffer</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span>
<a name="line-138"></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-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
<a name="line-139"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Builder</span>
<a name="line-140"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ForeignPtr</span> <span class='hs-conid'>Word8</span>
<a name="line-141"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-142"></a><span class='hs-definition'>toByteStringIOWithBuffer</span> <span class='hs-varid'>initBufSize</span> <span class='hs-varid'>io</span> <span class='hs-varid'>b</span> <span class='hs-varid'>initBuf</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-143"></a> <span class='hs-varid'>go</span> <span class='hs-varid'>initBufSize</span> <span class='hs-varid'>initBuf</span> <span class='hs-layout'>(</span><span class='hs-varid'>runBuilder</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span>
<a name="line-144"></a> <span class='hs-keyword'>where</span>
<a name="line-145"></a> <span class='hs-varid'>go</span> <span class='hs-varid'>bufSize</span> <span class='hs-varid'>buf</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>loop</span>
<a name="line-146"></a> <span class='hs-keyword'>where</span>
<a name="line-147"></a> <span class='hs-varid'>loop</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>BufferWriter</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-148"></a> <span class='hs-varid'>loop</span> <span class='hs-varid'>wr</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-149"></a> <span class='hs-layout'>(</span><span class='hs-varid'>len</span><span class='hs-layout'>,</span> <span class='hs-varid'>next</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>buf</span> <span class='hs-layout'>(</span><span class='hs-varid'>flip</span> <span class='hs-varid'>wr</span> <span class='hs-varid'>bufSize</span><span class='hs-layout'>)</span>
<a name="line-150"></a> <span class='hs-varid'>when</span> <span class='hs-layout'>(</span><span class='hs-varid'>len</span> <span class='hs-varop'>></span> <span class='hs-num'>0</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>io</span> <span class='hs-varop'>$!</span> <span class='hs-conid'>PS</span> <span class='hs-varid'>buf</span> <span class='hs-num'>0</span> <span class='hs-varid'>len</span><span class='hs-layout'>)</span>
<a name="line-151"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>next</span> <span class='hs-keyword'>of</span>
<a name="line-152"></a> <span class='hs-conid'>Done</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-conid'>More</span> <span class='hs-varid'>newBufSize</span> <span class='hs-varid'>nextWr</span>
<a name="line-154"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>newBufSize</span> <span class='hs-varop'>></span> <span class='hs-varid'>bufSize</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-155"></a> <span class='hs-varid'>newBuf</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>mallocByteString</span> <span class='hs-varid'>newBufSize</span>
<a name="line-156"></a> <span class='hs-varid'>go</span> <span class='hs-varid'>newBufSize</span> <span class='hs-varid'>newBuf</span> <span class='hs-varid'>nextWr</span>
<a name="line-157"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>loop</span> <span class='hs-varid'>nextWr</span>
<a name="line-158"></a> <span class='hs-conid'>Chunk</span> <span class='hs-varid'>s</span> <span class='hs-varid'>nextWr</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-159"></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'>s</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>io</span> <span class='hs-varid'>s</span><span class='hs-layout'>)</span>
<a name="line-160"></a> <span class='hs-varid'>loop</span> <span class='hs-varid'>nextWr</span>
<a name="line-161"></a>
<a name="line-162"></a><a name="toByteStringIOWith"></a><span class='hs-comment'>-- | @toByteStringIOWith bufSize io b@ runs the builder @b@ with a buffer of</span>
<a name="line-163"></a><span class='hs-comment'>-- at least the size @bufSize@ and executes the 'IO' action @io@ whenever the</span>
<a name="line-164"></a><span class='hs-comment'>-- buffer is full.</span>
<a name="line-165"></a><span class='hs-comment'>--</span>
<a name="line-166"></a><span class='hs-comment'>-- Compared to 'toLazyByteStringWith' this function requires less allocation,</span>
<a name="line-167"></a><span class='hs-comment'>-- as the output buffer is only allocated once at the start of the</span>
<a name="line-168"></a><span class='hs-comment'>-- serialization and whenever something bigger than the current buffer size has</span>
<a name="line-169"></a><span class='hs-comment'>-- to be copied into the buffer, which should happen very seldomly for the</span>
<a name="line-170"></a><span class='hs-comment'>-- default buffer size of 32kb. Hence, the pressure on the garbage collector is</span>
<a name="line-171"></a><span class='hs-comment'>-- reduced, which can be an advantage when building long sequences of bytes.</span>
<a name="line-172"></a><span class='hs-comment'>--</span>
<a name="line-173"></a><span class='hs-comment'>-- Since 0.1.9</span>
<a name="line-174"></a><span class='hs-comment'>--</span>
<a name="line-175"></a><span class='hs-definition'>toByteStringIOWith</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span> <span class='hs-comment'>-- ^ Buffer size (upper bounds</span>
<a name="line-176"></a> <span class='hs-comment'>-- the number of bytes forced</span>
<a name="line-177"></a> <span class='hs-comment'>-- per call to the 'IO' action).</span>
<a name="line-178"></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-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span> <span class='hs-comment'>-- ^ 'IO' action to execute per</span>
<a name="line-179"></a> <span class='hs-comment'>-- full buffer, which is</span>
<a name="line-180"></a> <span class='hs-comment'>-- referenced by a strict</span>
<a name="line-181"></a> <span class='hs-comment'>-- 'S.ByteString'.</span>
<a name="line-182"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Builder</span> <span class='hs-comment'>-- ^ 'Builder' to run.</span>
<a name="line-183"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-184"></a><span class='hs-definition'>toByteStringIOWith</span> <span class='hs-varid'>bufSize</span> <span class='hs-varid'>io</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>=</span>
<a name="line-185"></a> <span class='hs-varid'>toByteStringIOWithBuffer</span> <span class='hs-varid'>bufSize</span> <span class='hs-varid'>io</span> <span class='hs-varid'>b</span> <span class='hs-varop'>=<<</span> <span class='hs-varid'>mallocByteString</span> <span class='hs-varid'>bufSize</span>
<a name="line-186"></a><span class='hs-comment'>{-# INLINE toByteStringIOWith #-}</span>
<a name="line-187"></a>
<a name="line-188"></a><a name="toByteStringIO"></a><span class='hs-comment'>-- | Run the builder with a 'defaultChunkSize'd buffer and execute the given</span>
<a name="line-189"></a><span class='hs-comment'>-- 'IO' action whenever the buffer is full or gets flushed.</span>
<a name="line-190"></a><span class='hs-comment'>--</span>
<a name="line-191"></a><span class='hs-comment'>-- @ 'toByteStringIO' = 'toByteStringIOWith' 'defaultChunkSize'@</span>
<a name="line-192"></a><span class='hs-comment'>--</span>
<a name="line-193"></a><span class='hs-comment'>-- Since 0.1.9</span>
<a name="line-194"></a><span class='hs-comment'>--</span>
<a name="line-195"></a><span class='hs-definition'>toByteStringIO</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
<a name="line-196"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Builder</span>
<a name="line-197"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-198"></a><span class='hs-definition'>toByteStringIO</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>toByteStringIOWith</span> <span class='hs-varid'>defaultChunkSize</span>
<a name="line-199"></a><span class='hs-comment'>{-# INLINE toByteStringIO #-}</span>
</pre></body>
</html>
|