/usr/share/doc/libghc-blaze-builder-doc/html/src/Blaze-ByteString-Builder.html is in libghc-blaze-builder-doc 0.3.3.2-1.
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 | <?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>Blaze/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'>-----------------------------------------------------------------------------</span>
<a name="line-2"></a><span class='hs-comment'>-- |</span>
<a name="line-3"></a><span class='hs-comment'>-- Module : Blaze.ByteString.Builder</span>
<a name="line-4"></a><span class='hs-comment'>-- Copyright : (c) 2010 Jasper Van der Jeugt & Simon Meier</span>
<a name="line-5"></a><span class='hs-comment'>-- License : BSD3-style (see LICENSE)</span>
<a name="line-6"></a><span class='hs-comment'>--</span>
<a name="line-7"></a><span class='hs-comment'>-- Maintainer : Simon Meier <iridcode@gmail.com></span>
<a name="line-8"></a><span class='hs-comment'>-- Stability : experimental</span>
<a name="line-9"></a><span class='hs-comment'>-- Portability : tested on GHC only</span>
<a name="line-10"></a><span class='hs-comment'>--</span>
<a name="line-11"></a><span class='hs-comment'>-- "Blaze.ByteString.Builder" is the main module, which you should import as a user</span>
<a name="line-12"></a><span class='hs-comment'>-- of the @blaze-builder@ library.</span>
<a name="line-13"></a><span class='hs-comment'>--</span>
<a name="line-14"></a><span class='hs-comment'>-- > import Blaze.ByteString.Builder</span>
<a name="line-15"></a><span class='hs-comment'>--</span>
<a name="line-16"></a><span class='hs-comment'>-- It provides you with a type 'Builder' that allows to efficiently construct</span>
<a name="line-17"></a><span class='hs-comment'>-- lazy bytestrings with a large average chunk size.</span>
<a name="line-18"></a><span class='hs-comment'>--</span>
<a name="line-19"></a><span class='hs-comment'>-- Intuitively, a 'Builder' denotes the construction of a part of a lazy</span>
<a name="line-20"></a><span class='hs-comment'>-- bytestring. Builders can either be created using one of the primitive</span>
<a name="line-21"></a><span class='hs-comment'>-- combinators in "Blaze.ByteString.Builder.Write" or by using one of the predefined</span>
<a name="line-22"></a><span class='hs-comment'>-- combinators for standard Haskell values (see the exposed modules of this</span>
<a name="line-23"></a><span class='hs-comment'>-- package). Concatenation of builders is done using 'mappend' from the</span>
<a name="line-24"></a><span class='hs-comment'>-- 'Monoid' typeclass.</span>
<a name="line-25"></a><span class='hs-comment'>--</span>
<a name="line-26"></a><span class='hs-comment'>-- Here is a small example that serializes a list of strings using the UTF-8</span>
<a name="line-27"></a><span class='hs-comment'>-- encoding.</span>
<a name="line-28"></a><span class='hs-comment'>--</span>
<a name="line-29"></a><span class='hs-comment'>-- @ import "Blaze.ByteString.Builder.Char.Utf8"@</span>
<a name="line-30"></a><span class='hs-comment'>--</span>
<a name="line-31"></a><span class='hs-comment'>-- > strings :: [String]</span>
<a name="line-32"></a><span class='hs-comment'>-- > strings = replicate 10000 "Hello there!"</span>
<a name="line-33"></a><span class='hs-comment'>--</span>
<a name="line-34"></a><span class='hs-comment'>-- The function @'fromString'@ creates a 'Builder' denoting the UTF-8 encoded</span>
<a name="line-35"></a><span class='hs-comment'>-- argument. Hence, UTF-8 encoding and concatenating all @strings@ can be done</span>
<a name="line-36"></a><span class='hs-comment'>-- follows.</span>
<a name="line-37"></a><span class='hs-comment'>--</span>
<a name="line-38"></a><span class='hs-comment'>-- > concatenation :: Builder</span>
<a name="line-39"></a><span class='hs-comment'>-- > concatenation = mconcat $ map fromString strings</span>
<a name="line-40"></a><span class='hs-comment'>--</span>
<a name="line-41"></a><span class='hs-comment'>-- The function 'toLazyByteString' can be used to execute a 'Builder' and</span>
<a name="line-42"></a><span class='hs-comment'>-- obtain the resulting lazy bytestring.</span>
<a name="line-43"></a><span class='hs-comment'>--</span>
<a name="line-44"></a><span class='hs-comment'>-- > result :: L.ByteString</span>
<a name="line-45"></a><span class='hs-comment'>-- > result = toLazyByteString concatenation</span>
<a name="line-46"></a><span class='hs-comment'>--</span>
<a name="line-47"></a><span class='hs-comment'>-- The @result@ is a lazy bytestring containing 10000 repetitions of the string</span>
<a name="line-48"></a><span class='hs-comment'>-- @\"Hello there!\"@ encoded using UTF-8. The corresponding 120000 bytes are</span>
<a name="line-49"></a><span class='hs-comment'>-- distributed among three chunks of 32kb and a last chunk of 6kb.</span>
<a name="line-50"></a><span class='hs-comment'>--</span>
<a name="line-51"></a><span class='hs-comment'>-- /A note on history./ This serialization library was inspired by the</span>
<a name="line-52"></a><span class='hs-comment'>-- @Data.Binary.Builder@ module provided by the @binary@ package. It was</span>
<a name="line-53"></a><span class='hs-comment'>-- originally developed with the specific needs of the @blaze-html@ package in</span>
<a name="line-54"></a><span class='hs-comment'>-- mind. Since then it has been restructured to serve as a drop-in replacement</span>
<a name="line-55"></a><span class='hs-comment'>-- for @Data.Binary.Builder@, which it improves upon both in speed as well as</span>
<a name="line-56"></a><span class='hs-comment'>-- expressivity.</span>
<a name="line-57"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-58"></a>
<a name="line-59"></a><span class='hs-keyword'>module</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>
<a name="line-60"></a> <span class='hs-layout'>(</span>
<a name="line-61"></a> <span class='hs-comment'>-- * The 'Builder' type</span>
<a name="line-62"></a> <span class='hs-conid'>Builder</span>
<a name="line-63"></a>
<a name="line-64"></a> <span class='hs-comment'>-- * Creating builders</span>
<a name="line-65"></a> <span class='hs-layout'>,</span> <span class='hs-keyword'>module</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-varop'>.</span><span class='hs-conid'>Int</span>
<a name="line-66"></a> <span class='hs-layout'>,</span> <span class='hs-keyword'>module</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-varop'>.</span><span class='hs-conid'>Word</span>
<a name="line-67"></a> <span class='hs-layout'>,</span> <span class='hs-keyword'>module</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-varop'>.</span><span class='hs-conid'>ByteString</span>
<a name="line-68"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>flush</span>
<a name="line-69"></a>
<a name="line-70"></a> <span class='hs-comment'>-- * Executing builders</span>
<a name="line-71"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>toLazyByteString</span>
<a name="line-72"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>toLazyByteStringWith</span>
<a name="line-73"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>toByteString</span>
<a name="line-74"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>toByteStringIO</span>
<a name="line-75"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>toByteStringIOWith</span>
<a name="line-76"></a>
<a name="line-77"></a> <span class='hs-comment'>-- * 'Write's</span>
<a name="line-78"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Write</span>
<a name="line-79"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fromWrite</span>
<a name="line-80"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fromWriteSingleton</span>
<a name="line-81"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fromWriteList</span>
<a name="line-82"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>writeToByteString</span>
<a name="line-83"></a>
<a name="line-84"></a> <span class='hs-comment'>-- ** Writing 'Storable's</span>
<a name="line-85"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>writeStorable</span>
<a name="line-86"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fromStorable</span>
<a name="line-87"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fromStorables</span>
<a name="line-88"></a>
<a name="line-89"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-90"></a>
<a name="line-91"></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-varop'>.</span><span class='hs-conid'>Internal</span>
<a name="line-92"></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-varop'>.</span><span class='hs-conid'>Int</span>
<a name="line-93"></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-varop'>.</span><span class='hs-conid'>Word</span>
<a name="line-94"></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-varop'>.</span><span class='hs-conid'>ByteString</span>
<a name="line-95"></a>
</pre></body>
</html>
|