/usr/share/doc/libghc-conduit-extra-doc/html/src/Data-Conduit-Blaze.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 | <?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/Blaze.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>-- | Convert a stream of blaze-builder @Builder@s into a stream of @ByteString@s.</span>
<a name="line-2"></a><span class='hs-comment'>--</span>
<a name="line-3"></a><span class='hs-comment'>-- Adapted from blaze-builder-enumerator, written by myself and Simon Meier.</span>
<a name="line-4"></a><span class='hs-comment'>--</span>
<a name="line-5"></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-6"></a><span class='hs-comment'>-- @ST@.</span>
<a name="line-7"></a><span class='hs-comment'>--</span>
<a name="line-8"></a><span class='hs-comment'>-- Since 1.1.7.0, the functions here call their counterparts in</span>
<a name="line-9"></a><span class='hs-comment'>-- "Data.Conduit.ByteString.Builder", which work with both</span>
<a name="line-10"></a><span class='hs-comment'>-- 'Data.ByteString.Builder.Builder' and blaze-builder 0.3's</span>
<a name="line-11"></a><span class='hs-comment'>-- 'Blaze.ByteString.Builder.Builder'.</span>
<a name="line-12"></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'>Blaze</span>
<a name="line-13"></a> <span class='hs-layout'>(</span>
<a name="line-14"></a>
<a name="line-15"></a> <span class='hs-comment'>-- * Conduits from builders to bytestrings</span>
<a name="line-16"></a> <span class='hs-varid'>builderToByteString</span>
<a name="line-17"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>unsafeBuilderToByteString</span>
<a name="line-18"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>builderToByteStringWith</span>
<a name="line-19"></a>
<a name="line-20"></a> <span class='hs-comment'>-- ** Flush</span>
<a name="line-21"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>builderToByteStringFlush</span>
<a name="line-22"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>builderToByteStringWithFlush</span>
<a name="line-23"></a>
<a name="line-24"></a> <span class='hs-comment'>-- * Buffers</span>
<a name="line-25"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-conid'>Buffer</span>
<a name="line-26"></a>
<a name="line-27"></a> <span class='hs-comment'>-- ** Status information</span>
<a name="line-28"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-varid'>freeSize</span>
<a name="line-29"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-varid'>sliceSize</span>
<a name="line-30"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-varid'>bufferSize</span>
<a name="line-31"></a>
<a name="line-32"></a> <span class='hs-comment'>-- ** Creation and modification</span>
<a name="line-33"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-varid'>allocBuffer</span>
<a name="line-34"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-varid'>reuseBuffer</span>
<a name="line-35"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-varid'>nextSlice</span>
<a name="line-36"></a>
<a name="line-37"></a> <span class='hs-comment'>-- ** Conversion to bytestings</span>
<a name="line-38"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-varid'>unsafeFreezeBuffer</span>
<a name="line-39"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-varid'>unsafeFreezeNonEmptyBuffer</span>
<a name="line-40"></a>
<a name="line-41"></a> <span class='hs-comment'>-- * Buffer allocation strategies</span>
<a name="line-42"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-conid'>BufferAllocStrategy</span>
<a name="line-43"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-varid'>allNewBuffersStrategy</span>
<a name="line-44"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-varid'>reuseBufferStrategy</span>
<a name="line-45"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-46"></a>
<a name="line-47"></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-48"></a>
<a name="line-49"></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-50"></a>
<a name="line-51"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Blaze</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-52"></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>
<a name="line-53"></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>
<a name="line-54"></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'>Blaze</span>
<a name="line-55"></a>
<a name="line-56"></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'>Conduit</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-keyword'>as</span> <span class='hs-conid'>B</span>
<a name="line-57"></a>
<a name="line-58"></a><a name="builderToByteString"></a><span class='hs-comment'>-- | Incrementally execute builders and pass on the filled chunks as</span>
<a name="line-59"></a><span class='hs-comment'>-- bytestrings.</span>
<a name="line-60"></a><span class='hs-definition'>builderToByteString</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-keyglyph'>=></span> <span class='hs-conid'>Conduit</span> <span class='hs-conid'>Builder</span> <span class='hs-varid'>m</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span>
<a name="line-61"></a><span class='hs-definition'>builderToByteString</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-varid'>builderToByteString</span>
<a name="line-62"></a><span class='hs-comment'>{-# INLINE builderToByteString #-}</span>
<a name="line-63"></a>
<a name="line-64"></a><a name="builderToByteStringFlush"></a><span class='hs-comment'>-- |</span>
<a name="line-65"></a><span class='hs-comment'>--</span>
<a name="line-66"></a><span class='hs-comment'>-- Since 0.0.2</span>
<a name="line-67"></a><span class='hs-definition'>builderToByteStringFlush</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-keyglyph'>=></span> <span class='hs-conid'>Conduit</span> <span class='hs-layout'>(</span><span class='hs-conid'>Flush</span> <span class='hs-conid'>Builder</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'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span>
<a name="line-68"></a><span class='hs-definition'>builderToByteStringFlush</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-varid'>builderToByteStringFlush</span>
<a name="line-69"></a><span class='hs-comment'>{-# INLINE builderToByteStringFlush #-}</span>
<a name="line-70"></a>
<a name="line-71"></a><a name="unsafeBuilderToByteString"></a><span class='hs-comment'>-- | Incrementally execute builders on the given buffer and pass on the filled</span>
<a name="line-72"></a><span class='hs-comment'>-- chunks as bytestrings. Note that, if the given buffer is too small for the</span>
<a name="line-73"></a><span class='hs-comment'>-- execution of a build step, a larger one will be allocated.</span>
<a name="line-74"></a><span class='hs-comment'>--</span>
<a name="line-75"></a><span class='hs-comment'>-- WARNING: This conduit yields bytestrings that are NOT</span>
<a name="line-76"></a><span class='hs-comment'>-- referentially transparent. Their content will be overwritten as soon</span>
<a name="line-77"></a><span class='hs-comment'>-- as control is returned from the inner sink!</span>
<a name="line-78"></a><span class='hs-definition'>unsafeBuilderToByteString</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>
<a name="line-79"></a> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Buffer</span> <span class='hs-comment'>-- action yielding the inital buffer.</span>
<a name="line-80"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Conduit</span> <span class='hs-conid'>Builder</span> <span class='hs-varid'>m</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span>
<a name="line-81"></a><span class='hs-definition'>unsafeBuilderToByteString</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-varid'>unsafeBuilderToByteString</span>
<a name="line-82"></a><span class='hs-comment'>{-# INLINE unsafeBuilderToByteString #-}</span>
<a name="line-83"></a>
<a name="line-84"></a>
<a name="line-85"></a><a name="builderToByteStringWith"></a><span class='hs-comment'>-- | A conduit that incrementally executes builders and passes on the</span>
<a name="line-86"></a><span class='hs-comment'>-- filled chunks as bytestrings to an inner sink.</span>
<a name="line-87"></a><span class='hs-comment'>--</span>
<a name="line-88"></a><span class='hs-comment'>-- INV: All bytestrings passed to the inner sink are non-empty.</span>
<a name="line-89"></a><span class='hs-definition'>builderToByteStringWith</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>
<a name="line-90"></a> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>BufferAllocStrategy</span>
<a name="line-91"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Conduit</span> <span class='hs-conid'>Builder</span> <span class='hs-varid'>m</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span>
<a name="line-92"></a><span class='hs-definition'>builderToByteStringWith</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-varid'>builderToByteStringWith</span>
<a name="line-93"></a><span class='hs-comment'>{-# INLINE builderToByteStringWith #-}</span>
<a name="line-94"></a>
<a name="line-95"></a><a name="builderToByteStringWithFlush"></a><span class='hs-comment'>-- |</span>
<a name="line-96"></a><span class='hs-comment'>--</span>
<a name="line-97"></a><span class='hs-comment'>-- Since 0.0.2</span>
<a name="line-98"></a><span class='hs-definition'>builderToByteStringWithFlush</span>
<a name="line-99"></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>
<a name="line-100"></a> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>BufferAllocStrategy</span>
<a name="line-101"></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'>Builder</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'>S</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span>
<a name="line-102"></a><span class='hs-definition'>builderToByteStringWithFlush</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-varid'>builderToByteStringWithFlush</span>
<a name="line-103"></a><span class='hs-comment'>{-# INLINE builderToByteStringWithFlush #-}</span>
</pre></body>
</html>
|