Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > decccc6a629f077e549a3762e84f29fd > files > 49

ghc-blaze-builder-devel-0.2.1.4-1.fc14.i686.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>Blaze.ByteString.Builder</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock-util.js" TYPE="text/javascript"
></SCRIPT
><SCRIPT TYPE="text/javascript"
>window.onload = function () {setSynopsis("mini_Blaze-ByteString-Builder.html")};</SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
>blaze-builder-0.2.1.4: Efficient buffered output.</TD
><TD CLASS="topbut"
><A HREF="src/Blaze-ByteString-Builder.html"
>Source code</A
></TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>Blaze.ByteString.Builder</FONT
></TD
><TD ALIGN="right"
><TABLE CLASS="narrow" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="infohead"
>Portability</TD
><TD CLASS="infoval"
>tested on GHC only</TD
></TR
><TR
><TD CLASS="infohead"
>Stability</TD
><TD CLASS="infoval"
>experimental</TD
></TR
><TR
><TD CLASS="infohead"
>Maintainer</TD
><TD CLASS="infoval"
>Simon Meier &lt;iridcode@gmail.com&gt;</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="section4"
><B
>Contents</B
></TD
></TR
><TR
><TD
><DL
><DT
><A HREF="#1"
>The <TT
><A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TT
> type
</A
></DT
><DT
><A HREF="#2"
>Creating builders
</A
></DT
><DT
><A HREF="#3"
>Executing builders
</A
></DT
><DT
><A HREF="#4"
><TT
><A HREF="Blaze-ByteString-Builder.html#t%3AWrite"
>Write</A
></TT
>s
</A
></DT
><DD
><DL
><DT
><A HREF="#5"
>Writing Storables
</A
></DT
></DL
></DD
></DL
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
><P
><A HREF="Blaze-ByteString-Builder.html"
>Blaze.ByteString.Builder</A
> is the main module, which you should import as a user
 of the <TT
>blaze-builder</TT
> library.
</P
><PRE
> import Blaze.ByteString.Builder
</PRE
><P
>It provides you with a type <TT
><A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TT
> that allows to efficiently construct
 lazy bytestrings with a large average chunk size.
</P
><P
>Intuitively, a <TT
><A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TT
> denotes the construction of a part of a lazy
 bytestring. Builders can either be created using one of the primitive
 combinators in <A HREF="Blaze-ByteString-Builder-Write.html"
>Blaze.ByteString.Builder.Write</A
> or by using one of the predefined
 combinators for standard Haskell values (see the exposed modules of this
 package).  Concatenation of builders is done using mappend from the
 Monoid typeclass.
</P
><P
>Here is a small example that serializes a list of strings using the UTF-8
 encoding.
</P
><PRE
> import <A HREF="Blaze-ByteString-Builder-Char-Utf8.html"
>Blaze.ByteString.Builder.Char.Utf8</A
></PRE
><PRE
> strings :: [String]
 strings = replicate 10000 &quot;Hello there!&quot;
</PRE
><P
>The function <TT
>fromString</TT
> creates a <TT
><A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TT
> denoting the UTF-8 encoded
 argument. Hence, UTF-8 encoding and concatenating all <TT
>strings</TT
> can be done
 follows.
</P
><PRE
> concatenation :: Builder
 concatenation = mconcat $ map fromString strings
</PRE
><P
>The function <TT
><A HREF="Blaze-ByteString-Builder.html#v%3AtoLazyByteString"
>toLazyByteString</A
></TT
>  can be used to execute a <TT
><A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TT
> and
 obtain the resulting lazy bytestring.
</P
><PRE
> result :: L.ByteString
 result = toLazyByteString concatenation
</PRE
><P
>The <TT
>result</TT
> is a lazy bytestring containing 10000 repetitions of the string
 <TT
>&quot;Hello there!&quot;</TT
> encoded using UTF-8. The corresponding 120000 bytes are
 distributed among three chunks of 32kb and a last chunk of 6kb.
</P
><P
><EM
>A note on history.</EM
> This serialization library was inspired by the
 <TT
>Data.Binary.Builder</TT
> module provided by the <TT
>binary</TT
> package. It was
 originally developed with the specific needs of the <TT
>blaze-html</TT
> package in
 mind. Since then it has been restructured to serve as a drop-in replacement
 for <TT
>Data.Binary.Builder</TT
>, which it improves upon both in speed as well as
 expressivity.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3ABuilder"
>Builder</A
> </TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
>module <A HREF="Blaze-ByteString-Builder-Int.html"
>Blaze.ByteString.Builder.Int</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
>module <A HREF="Blaze-ByteString-Builder-Word.html"
>Blaze.ByteString.Builder.Word</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
>module <A HREF="Blaze-ByteString-Builder-ByteString.html"
>Blaze.ByteString.Builder.ByteString</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Aflush"
>flush</A
> :: <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AtoLazyByteString"
>toLazyByteString</A
> :: <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/bytestring-0.9.1.7/Data-ByteString-Lazy.html#t%3AByteString"
>ByteString</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AtoLazyByteStringWith"
>toLazyByteStringWith</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t%3AInt"
>Int</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t%3AInt"
>Int</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t%3AInt"
>Int</A
> -&gt; <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/bytestring-0.9.1.7/Data-ByteString-Lazy.html#t%3AByteString"
>ByteString</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/bytestring-0.9.1.7/Data-ByteString-Lazy.html#t%3AByteString"
>ByteString</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AtoByteString"
>toByteString</A
> :: <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/bytestring-0.9.1.7/Data-ByteString.html#t%3AByteString"
>ByteString</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AtoByteStringIO"
>toByteStringIO</A
> :: (<A HREF="/usr/share/doc/ghc/html/libraries/bytestring-0.9.1.7/Data-ByteString.html#t%3AByteString"
>ByteString</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
>) -&gt; <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AtoByteStringIOWith"
>toByteStringIOWith</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t%3AInt"
>Int</A
> -&gt; (<A HREF="/usr/share/doc/ghc/html/libraries/bytestring-0.9.1.7/Data-ByteString.html#t%3AByteString"
>ByteString</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
>) -&gt; <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3AWrite"
>Write</A
> </TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfromWrite"
>fromWrite</A
> :: <A HREF="Blaze-ByteString-Builder.html#t%3AWrite"
>Write</A
> -&gt; <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfromWriteSingleton"
>fromWriteSingleton</A
> ::  (a -&gt; <A HREF="Blaze-ByteString-Builder.html#t%3AWrite"
>Write</A
>) -&gt; a -&gt; <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfromWriteList"
>fromWriteList</A
> ::  (a -&gt; <A HREF="Blaze-ByteString-Builder.html#t%3AWrite"
>Write</A
>) -&gt; [a] -&gt; <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AwriteStorable"
>writeStorable</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Foreign-Storable.html#t%3AStorable"
>Storable</A
> a =&gt; a -&gt; <A HREF="Blaze-ByteString-Builder.html#t%3AWrite"
>Write</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfromStorable"
>fromStorable</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Foreign-Storable.html#t%3AStorable"
>Storable</A
> a =&gt; a -&gt; <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfromStorables"
>fromStorables</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Foreign-Storable.html#t%3AStorable"
>Storable</A
> a =&gt; [a] -&gt; <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="1"
><A NAME="1"
>The <TT
><A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TT
> type
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:Builder"
><A NAME="t%3ABuilder"
></A
></A
><B
>Builder</B
>  </TD
><TD CLASS="declbut"
><A HREF="src/Blaze-ByteString-Builder-Internal-Types.html#Builder"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:Builder')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:Builder" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Monoid.html#t%3AMonoid"
>Monoid</A
> <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="2"
><A NAME="2"
>Creating builders
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
>module <A HREF="Blaze-ByteString-Builder-Int.html"
>Blaze.ByteString.Builder.Int</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
>module <A HREF="Blaze-ByteString-Builder-Word.html"
>Blaze.ByteString.Builder.Word</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
>module <A HREF="Blaze-ByteString-Builder-ByteString.html"
>Blaze.ByteString.Builder.ByteString</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:flush"
><A NAME="v%3Aflush"
></A
></A
><B
>flush</B
> :: <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TD
><TD CLASS="declbut"
><A HREF="src/Blaze-ByteString-Builder-Internal.html#flush"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
>Output all data written in the current buffer and start a new chunk.
</P
><P
>The use uf this function depends on how the resulting bytestrings are
 consumed. <TT
><A HREF="Blaze-ByteString-Builder.html#v%3Aflush"
>flush</A
></TT
> is possibly not very useful in non-interactive scenarios.
 However, it is kept for compatibility with the builder provided by
 Data.Binary.Builder.
</P
><P
>When using <TT
><A HREF="Blaze-ByteString-Builder.html#v%3AtoLazyByteString"
>toLazyByteString</A
></TT
> to extract a lazy <TT
><A HREF="/usr/share/doc/ghc/html/libraries/bytestring-0.9.1.7/Data-ByteString-Lazy.html#t%3AByteString"
>ByteString</A
></TT
> from a
 <TT
><A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TT
>, this means that a new chunk will be started in the resulting lazy
 <TT
><A HREF="/usr/share/doc/ghc/html/libraries/bytestring-0.9.1.7/Data-ByteString-Lazy.html#t%3AByteString"
>ByteString</A
></TT
>. The remaining part of the buffer is spilled, if the
 reamining free space is smaller than the minimal desired buffer size.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="3"
><A NAME="3"
>Executing builders
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:toLazyByteString"
><A NAME="v%3AtoLazyByteString"
></A
></A
><B
>toLazyByteString</B
> :: <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/bytestring-0.9.1.7/Data-ByteString-Lazy.html#t%3AByteString"
>ByteString</A
></TD
><TD CLASS="declbut"
><A HREF="src/Blaze-ByteString-Builder-Internal.html#toLazyByteString"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
>Extract the lazy <TT
><A HREF="/usr/share/doc/ghc/html/libraries/bytestring-0.9.1.7/Data-ByteString-Lazy.html#t%3AByteString"
>ByteString</A
></TT
> from the builder by running it with default
 buffer sizes. Use this function, if you do not have any special
 considerations with respect to buffer sizes.
</P
><PRE
> <TT
><A HREF="Blaze-ByteString-Builder.html#v%3AtoLazyByteString"
>toLazyByteString</A
></TT
> b = <TT
><A HREF="Blaze-ByteString-Builder.html#v%3AtoLazyByteStringWith"
>toLazyByteStringWith</A
></TT
> <TT
><A HREF="Blaze-ByteString-Builder-Internal.html#v%3AdefaultBufferSize"
>defaultBufferSize</A
></TT
> <TT
><A HREF="Blaze-ByteString-Builder-Internal.html#v%3AdefaultMinimalBufferSize"
>defaultMinimalBufferSize</A
></TT
> <TT
><A HREF="Blaze-ByteString-Builder-Internal.html#v%3AdefaultFirstBufferSize"
>defaultFirstBufferSize</A
></TT
> b L.empty</PRE
><P
>Note that <TT
><TT
><A HREF="Blaze-ByteString-Builder.html#v%3AtoLazyByteString"
>toLazyByteString</A
></TT
></TT
> is a Monoid homomorphism.
</P
><PRE
> toLazyByteString mempty          == mempty
 toLazyByteString (x `mappend` y) == toLazyByteString x `mappend` toLazyByteString y
</PRE
><P
>However, in the second equation, the left-hand-side is generally faster to
 execute.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:toLazyByteStringWith"
><A NAME="v%3AtoLazyByteStringWith"
></A
></A
><B
>toLazyByteStringWith</B
></TD
><TD CLASS="declbut"
><A HREF="src/Blaze-ByteString-Builder-Internal.html#toLazyByteStringWith"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t%3AInt"
>Int</A
></TD
><TD CLASS="rdoc"
>Buffer size (upper-bounds the resulting chunk size).
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t%3AInt"
>Int</A
></TD
><TD CLASS="rdoc"
>Minimal free buffer space for continuing filling
 the same buffer after a <TT
><A HREF="Blaze-ByteString-Builder.html#v%3Aflush"
>flush</A
></TT
> or a direct bytestring
 insertion. This corresponds to the minimal desired
 chunk size.
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t%3AInt"
>Int</A
></TD
><TD CLASS="rdoc"
>Size of the first buffer to be used and copied for
 larger resulting sequences
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TD
><TD CLASS="rdoc"
>Builder to run.
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="/usr/share/doc/ghc/html/libraries/bytestring-0.9.1.7/Data-ByteString-Lazy.html#t%3AByteString"
>ByteString</A
></TD
><TD CLASS="rdoc"
>Lazy bytestring to output after the builder is
 finished.
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="/usr/share/doc/ghc/html/libraries/bytestring-0.9.1.7/Data-ByteString-Lazy.html#t%3AByteString"
>ByteString</A
></TD
><TD CLASS="rdoc"
>Resulting lazy bytestring
</TD
></TR
><TR
><TD CLASS="ndoc" COLSPAN="2"
><P
>Run a <TT
><A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TT
> with the given buffer sizes.
</P
><P
>Use this function for integrating the <TT
><A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TT
> type with other libraries
 that generate lazy bytestrings.
</P
><P
>Note that the builders should guarantee that on average the desired chunk
 size is attained. Builders may decide to start a new buffer and not
 completely fill the existing buffer, if this is faster. However, they should
 not spill too much of the buffer, if they cannot compensate for it.
</P
><P
>A call <TT
>toLazyByteStringWith bufSize minBufSize firstBufSize</TT
> will generate
 a lazy bytestring according to the following strategy. First, we allocate
 a buffer of size <TT
>firstBufSize</TT
> and start filling it. If it overflows, we
 allocate a buffer of size <TT
>minBufSize</TT
> and copy the first buffer to it in
 order to avoid generating a too small chunk. Finally, every next buffer will
 be of size <TT
>bufSize</TT
>. This, slow startup strategy is required to achieve
 good speed for short (&lt;200 bytes) resulting bytestrings, as for them the
 allocation cost is of a large buffer cannot be compensated. Moreover, this
 strategy also allows us to avoid spilling too much memory for short
 resulting bytestrings.
</P
><P
>Note that setting <TT
>firstBufSize &gt;= minBufSize</TT
> implies that the first buffer
 is no longer copied but allocated and filled directly. Hence, setting
 <TT
>firstBufSize = bufSize</TT
> means that all chunks will use an underlying buffer
 of size <TT
>bufSize</TT
>. This is recommended, if you know that you always output
 more than <TT
>minBufSize</TT
> bytes.
</P
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:toByteString"
><A NAME="v%3AtoByteString"
></A
></A
><B
>toByteString</B
> :: <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/bytestring-0.9.1.7/Data-ByteString.html#t%3AByteString"
>ByteString</A
></TD
><TD CLASS="declbut"
><A HREF="src/Blaze-ByteString-Builder-Internal.html#toByteString"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
>Run the builder to construct a strict bytestring containing the sequence
 of bytes denoted by the builder. This is done by first serializing to a lazy bytestring and then packing its
 chunks to a appropriately sized strict bytestring.
</P
><PRE
> toByteString = packChunks . toLazyByteString
</PRE
><P
>Note that <TT
><TT
><A HREF="Blaze-ByteString-Builder.html#v%3AtoByteString"
>toByteString</A
></TT
></TT
> is a Monoid homomorphism.
</P
><PRE
> toByteString mempty          == mempty
 toByteString (x `mappend` y) == toByteString x `mappend` toByteString y
</PRE
><P
>However, in the second equation, the left-hand-side is generally faster to
 execute.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:toByteStringIO"
><A NAME="v%3AtoByteStringIO"
></A
></A
><B
>toByteStringIO</B
> :: (<A HREF="/usr/share/doc/ghc/html/libraries/bytestring-0.9.1.7/Data-ByteString.html#t%3AByteString"
>ByteString</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
>) -&gt; <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
><TD CLASS="declbut"
><A HREF="src/Blaze-ByteString-Builder-Internal.html#toByteStringIO"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
>Run the builder with a <TT
><A HREF="Blaze-ByteString-Builder-Internal.html#v%3AdefaultBufferSize"
>defaultBufferSize</A
></TT
>d buffer and execute the given
 <TT
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
></TT
> action whenever the buffer is full or gets flushed.
</P
><PRE
> <TT
><A HREF="Blaze-ByteString-Builder.html#v%3AtoByteStringIO"
>toByteStringIO</A
></TT
> = <TT
><A HREF="Blaze-ByteString-Builder.html#v%3AtoByteStringIOWith"
>toByteStringIOWith</A
></TT
> <TT
><A HREF="Blaze-ByteString-Builder-Internal.html#v%3AdefaultBufferSize"
>defaultBufferSize</A
></TT
></PRE
><P
>This is a Monoid homomorphism in the following sense.
</P
><PRE
> toByteStringIO io mempty          == return ()
 toByteStringIO io (x `mappend` y) == toByteStringIO io x &gt;&gt; toByteStringIO io y
</PRE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:toByteStringIOWith"
><A NAME="v%3AtoByteStringIOWith"
></A
></A
><B
>toByteStringIOWith</B
></TD
><TD CLASS="declbut"
><A HREF="src/Blaze-ByteString-Builder-Internal.html#toByteStringIOWith"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t%3AInt"
>Int</A
></TD
><TD CLASS="rdoc"
>Buffer size (upper bounds
 the number of bytes forced
 per call to the <TT
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
></TT
> action).
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="/usr/share/doc/ghc/html/libraries/bytestring-0.9.1.7/Data-ByteString.html#t%3AByteString"
>ByteString</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
><TD CLASS="rdoc"
><TT
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
></TT
> action to execute per
 full buffer, which is
 referenced by a strict
 <TT
><A HREF="/usr/share/doc/ghc/html/libraries/bytestring-0.9.1.7/Data-ByteString.html#t%3AByteString"
>ByteString</A
></TT
>.
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TD
><TD CLASS="rdoc"
><TT
><A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TT
> to run.
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
><TD CLASS="rdoc"
>Resulting <TT
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
></TT
> action.
</TD
></TR
><TR
><TD CLASS="ndoc" COLSPAN="2"
><P
><TT
>toByteStringIOWith bufSize io b</TT
> runs the builder <TT
>b</TT
> with a buffer of
 at least the size <TT
>bufSize</TT
> and executes the <TT
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
></TT
> action <TT
>io</TT
> whenever the
 buffer is full.
</P
><P
>Compared to <TT
><A HREF="Blaze-ByteString-Builder.html#v%3AtoLazyByteStringWith"
>toLazyByteStringWith</A
></TT
> this function requires less allocation,
 as the output buffer is only allocated once at the start of the
 serialization and whenever something bigger than the current buffer size has
 to be copied into the buffer, which should happen very seldomly for the
 default buffer size of 32kb. Hence, the pressure on the garbage collector is
 reduced, which can be an advantage when building long sequences of bytes.
</P
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="4"
><A NAME="4"
><TT
><A HREF="Blaze-ByteString-Builder.html#t%3AWrite"
>Write</A
></TT
>s
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:Write"
><A NAME="t%3AWrite"
></A
></A
><B
>Write</B
>  </TD
><TD CLASS="declbut"
><A HREF="src/Blaze-ByteString-Builder-Internal-Write.html#Write"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>A write of a bounded number of bytes.
</TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:Write')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:Write" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Monoid.html#t%3AMonoid"
>Monoid</A
> <A HREF="Blaze-ByteString-Builder.html#t%3AWrite"
>Write</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:fromWrite"
><A NAME="v%3AfromWrite"
></A
></A
><B
>fromWrite</B
> :: <A HREF="Blaze-ByteString-Builder.html#t%3AWrite"
>Write</A
> -&gt; <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TD
><TD CLASS="declbut"
><A HREF="src/Blaze-ByteString-Builder-Internal-Write.html#fromWrite"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:fromWriteSingleton"
><A NAME="v%3AfromWriteSingleton"
></A
></A
><B
>fromWriteSingleton</B
> ::  (a -&gt; <A HREF="Blaze-ByteString-Builder.html#t%3AWrite"
>Write</A
>) -&gt; a -&gt; <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TD
><TD CLASS="declbut"
><A HREF="src/Blaze-ByteString-Builder-Internal-Write.html#fromWriteSingleton"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:fromWriteList"
><A NAME="v%3AfromWriteList"
></A
></A
><B
>fromWriteList</B
> ::  (a -&gt; <A HREF="Blaze-ByteString-Builder.html#t%3AWrite"
>Write</A
>) -&gt; [a] -&gt; <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TD
><TD CLASS="declbut"
><A HREF="src/Blaze-ByteString-Builder-Internal-Write.html#fromWriteList"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Construct a <TT
><A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TT
> writing a list of data one element at a time.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="5"
><A NAME="5"
>Writing Storables
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:writeStorable"
><A NAME="v%3AwriteStorable"
></A
></A
><B
>writeStorable</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Foreign-Storable.html#t%3AStorable"
>Storable</A
> a =&gt; a -&gt; <A HREF="Blaze-ByteString-Builder.html#t%3AWrite"
>Write</A
></TD
><TD CLASS="declbut"
><A HREF="src/Blaze-ByteString-Builder-Internal-Write.html#writeStorable"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Write a storable value.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:fromStorable"
><A NAME="v%3AfromStorable"
></A
></A
><B
>fromStorable</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Foreign-Storable.html#t%3AStorable"
>Storable</A
> a =&gt; a -&gt; <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TD
><TD CLASS="declbut"
><A HREF="src/Blaze-ByteString-Builder-Internal-Write.html#fromStorable"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>A builder that serializes a storable value. No alignment is done.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:fromStorables"
><A NAME="v%3AfromStorables"
></A
></A
><B
>fromStorables</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Foreign-Storable.html#t%3AStorable"
>Storable</A
> a =&gt; [a] -&gt; <A HREF="Blaze-ByteString-Builder.html#t%3ABuilder"
>Builder</A
></TD
><TD CLASS="declbut"
><A HREF="src/Blaze-ByteString-Builder-Internal-Write.html#fromStorables"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>A builder that serializes a list of storable values by writing them
 consecutively. No alignment is done. Parsing information needs to be
 provided externally.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 2.6.1</TD
></TR
></TABLE
></BODY
></HTML
>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional