Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > 53be4b908f5603d39c263bea2a996239 > files > 82

ghc-text-devel-0.8.1.0-1.fc14.1.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
>Data.Text.Lazy.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_Data-Text-Lazy-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"
>text-0.8.1.0: An efficient packed Unicode text type.</TD
><TD CLASS="topbut"
><A HREF="src/Data-Text-Lazy-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"
>Data.Text.Lazy.Builder</FONT
></TD
><TD ALIGN="right"
><TABLE CLASS="narrow" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="infohead"
>Portability</TD
><TD CLASS="infoval"
>portable to Hugs and GHC</TD
></TR
><TR
><TD CLASS="infohead"
>Stability</TD
><TD CLASS="infoval"
>experimental</TD
></TR
><TR
><TD CLASS="infohead"
>Maintainer</TD
><TD CLASS="infoval"
>Johan Tibell &lt;johan.tibell@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 Builder type
</A
></DT
><DT
><A HREF="#2"
>Constructing Builders
</A
></DT
><DT
><A HREF="#3"
>Flushing the buffer state
</A
></DT
></DL
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
>Efficient construction of lazy texts.
</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"
><A HREF="#v%3AtoLazyText"
>toLazyText</A
> :: <A HREF="Data-Text-Lazy-Builder.html#t%3ABuilder"
>Builder</A
> -&gt; <A HREF="Data-Text-Lazy.html#t%3AText"
>Text</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AtoLazyTextWith"
>toLazyTextWith</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t%3AInt"
>Int</A
> -&gt; <A HREF="Data-Text-Lazy-Builder.html#t%3ABuilder"
>Builder</A
> -&gt; <A HREF="Data-Text-Lazy.html#t%3AText"
>Text</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Asingleton"
>singleton</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AChar"
>Char</A
> -&gt; <A HREF="Data-Text-Lazy-Builder.html#t%3ABuilder"
>Builder</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfromText"
>fromText</A
> :: <A HREF="Data-Text.html#t%3AText"
>Text</A
> -&gt; <A HREF="Data-Text-Lazy-Builder.html#t%3ABuilder"
>Builder</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfromLazyText"
>fromLazyText</A
> :: <A HREF="Data-Text-Lazy.html#t%3AText"
>Text</A
> -&gt; <A HREF="Data-Text-Lazy-Builder.html#t%3ABuilder"
>Builder</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Aflush"
>flush</A
> :: <A HREF="Data-Text-Lazy-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 Builder 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/Data-Text-Lazy-Builder.html#Builder"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
><P
>A <TT
><A HREF="Data-Text-Lazy-Builder.html#t%3ABuilder"
>Builder</A
></TT
> is an efficient way to build lazy <TT
><A HREF="Data-Text-Lazy.html#t%3AText"
>Text</A
></TT
>s.  There
 are several functions for constructing <TT
><A HREF="Data-Text-Lazy-Builder.html#t%3ABuilder"
>Builder</A
></TT
>s, but only one to
 inspect them: to extract any data, you have to turn them into lazy
 <TT
><A HREF="Data-Text-Lazy.html#t%3AText"
>Text</A
></TT
>s using <TT
><A HREF="Data-Text-Lazy-Builder.html#v%3AtoLazyText"
>toLazyText</A
></TT
>.
</P
><P
>Internally, a <TT
><A HREF="Data-Text-Lazy-Builder.html#t%3ABuilder"
>Builder</A
></TT
> constructs a lazy <TT
><A HREF="Data-Text-Lazy.html#t%3AText"
>Text</A
></TT
> by filling byte
 arrays piece by piece.  As each buffer is filled, it is 'popped'
 off, to become a new chunk of the resulting lazy <TT
><A HREF="Data-Text-Lazy.html#t%3AText"
>Text</A
></TT
>.  All
 this is hidden from the user of the <TT
><A HREF="Data-Text-Lazy-Builder.html#t%3ABuilder"
>Builder</A
></TT
>.
</P
></TD
></TR
><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/Text-Show.html#t%3AShow"
>Show</A
> <A HREF="Data-Text-Lazy-Builder.html#t%3ABuilder"
>Builder</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-String.html#t%3AIsString"
>IsString</A
> <A HREF="Data-Text-Lazy-Builder.html#t%3ABuilder"
>Builder</A
></TD
></TR
><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="Data-Text-Lazy-Builder.html#t%3ABuilder"
>Builder</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:toLazyText"
><A NAME="v%3AtoLazyText"
></A
></A
><B
>toLazyText</B
> :: <A HREF="Data-Text-Lazy-Builder.html#t%3ABuilder"
>Builder</A
> -&gt; <A HREF="Data-Text-Lazy.html#t%3AText"
>Text</A
></TD
><TD CLASS="declbut"
><A HREF="src/Data-Text-Lazy-Builder.html#toLazyText"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><EM
>O(n).</EM
> Extract a lazy <TT
><A HREF="Data-Text-Lazy.html#t%3AText"
>Text</A
></TT
> from a <TT
><A HREF="Data-Text-Lazy-Builder.html#t%3ABuilder"
>Builder</A
></TT
> with a default
 buffer size.  The construction work takes place if and when the
 relevant part of the lazy <TT
><A HREF="Data-Text-Lazy.html#t%3AText"
>Text</A
></TT
> is demanded.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:toLazyTextWith"
><A NAME="v%3AtoLazyTextWith"
></A
></A
><B
>toLazyTextWith</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t%3AInt"
>Int</A
> -&gt; <A HREF="Data-Text-Lazy-Builder.html#t%3ABuilder"
>Builder</A
> -&gt; <A HREF="Data-Text-Lazy.html#t%3AText"
>Text</A
></TD
><TD CLASS="declbut"
><A HREF="src/Data-Text-Lazy-Builder.html#toLazyTextWith"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
><EM
>O(n).</EM
> Extract a lazy <TT
><A HREF="Data-Text-Lazy.html#t%3AText"
>Text</A
></TT
> from a <TT
><A HREF="Data-Text-Lazy-Builder.html#t%3ABuilder"
>Builder</A
></TT
>, using the given
 size for the initial buffer.  The construction work takes place if
 and when the relevant part of the lazy <TT
><A HREF="Data-Text-Lazy.html#t%3AText"
>Text</A
></TT
> is demanded.
</P
><P
>If the initial buffer is too small to hold all data, subsequent
 buffers will be the default buffer size.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="2"
><A NAME="2"
>Constructing 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:singleton"
><A NAME="v%3Asingleton"
></A
></A
><B
>singleton</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AChar"
>Char</A
> -&gt; <A HREF="Data-Text-Lazy-Builder.html#t%3ABuilder"
>Builder</A
></TD
><TD CLASS="declbut"
><A HREF="src/Data-Text-Lazy-Builder.html#singleton"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
><EM
>O(1).</EM
> A Builder taking a single character, satisfying
</P
><UL
><LI
><PRE
><TT
><A HREF="Data-Text-Lazy-Builder.html#v%3AtoLazyText"
>toLazyText</A
></TT
> (<TT
><A HREF="Data-Text-Lazy-Builder.html#v%3Asingleton"
>singleton</A
></TT
> c) = <TT
><A HREF="Data-Text-Lazy.html#v%3Asingleton"
>singleton</A
></TT
> c</PRE
></LI
></UL
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:fromText"
><A NAME="v%3AfromText"
></A
></A
><B
>fromText</B
> :: <A HREF="Data-Text.html#t%3AText"
>Text</A
> -&gt; <A HREF="Data-Text-Lazy-Builder.html#t%3ABuilder"
>Builder</A
></TD
><TD CLASS="declbut"
><A HREF="src/Data-Text-Lazy-Builder.html#fromText"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
><EM
>O(1).</EM
> A Builder taking a <TT
><A HREF="Data-Text.html#t%3AText"
>Text</A
></TT
>, satisfying
</P
><UL
><LI
><PRE
><TT
><A HREF="Data-Text-Lazy-Builder.html#v%3AtoLazyText"
>toLazyText</A
></TT
> (<TT
><A HREF="Data-Text-Lazy-Builder.html#v%3AfromText"
>fromText</A
></TT
> t) = <TT
><A HREF="Data-Text-Lazy.html#v%3AfromChunks"
>fromChunks</A
></TT
> [t]</PRE
></LI
></UL
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:fromLazyText"
><A NAME="v%3AfromLazyText"
></A
></A
><B
>fromLazyText</B
> :: <A HREF="Data-Text-Lazy.html#t%3AText"
>Text</A
> -&gt; <A HREF="Data-Text-Lazy-Builder.html#t%3ABuilder"
>Builder</A
></TD
><TD CLASS="declbut"
><A HREF="src/Data-Text-Lazy-Builder.html#fromLazyText"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
><EM
>O(1).</EM
> A Builder taking a lazy <TT
><A HREF="Data-Text-Lazy.html#t%3AText"
>Text</A
></TT
>, satisfying
</P
><UL
><LI
><PRE
><TT
><A HREF="Data-Text-Lazy-Builder.html#v%3AtoLazyText"
>toLazyText</A
></TT
> (<TT
><A HREF="Data-Text-Lazy-Builder.html#v%3AfromLazyText"
>fromLazyText</A
></TT
> t) = t</PRE
></LI
></UL
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="3"
><A NAME="3"
>Flushing the buffer state
</A
></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="Data-Text-Lazy-Builder.html#t%3ABuilder"
>Builder</A
></TD
><TD CLASS="declbut"
><A HREF="src/Data-Text-Lazy-Builder.html#flush"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><EM
>O(1).</EM
> Pop the <TT
><A HREF="Data-Text.html#t%3AText"
>Text</A
></TT
> we have constructed so far, if any,
 yielding a new chunk in the result lazy <TT
><A HREF="Data-Text-Lazy.html#t%3AText"
>Text</A
></TT
>.
</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