Text-ParserCombinators-Poly-ByteString.html

<!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
>Text.ParserCombinators.Poly.ByteString</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_Text-ParserCombinators-Poly-ByteString.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"
>polyparse</TD
><TD CLASS="topbut"
><A HREF="src/Text/ParserCombinators/Poly/ByteString.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"
>Text.ParserCombinators.Poly.ByteString</FONT
></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 Parser datatype
</A
></DT
><DD
><DL
><DT
><A HREF="#2"
>basic parsers
</A
></DT
><DT
><A HREF="#3"
>re-parsing
</A
></DT
></DL
></DD
><DT
><A HREF="#4"
>Re-export all more general combinators
</A
></DT
></DL
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></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"
>newtype</SPAN
>  <A HREF="#t%3AParser"
>Parser</A
> a = <A HREF="#v%3AP"
>P</A
> (ByteString -&gt; <A HREF="Text-ParserCombinators-Poly-ByteString.html#t%3AResult"
>Result</A
> ByteString a)</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3AResult"
>Result</A
> z a </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
>= <A HREF="#v%3ASuccess"
>Success</A
> z a</TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AFailure"
>Failure</A
> z String</TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ACommitted"
>Committed</A
> (<A HREF="Text-ParserCombinators-Poly-ByteString.html#t%3AResult"
>Result</A
> z a)</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3ArunParser"
>runParser</A
> ::  <A HREF="Text-ParserCombinators-Poly-ByteString.html#t%3AParser"
>Parser</A
> a -&gt; ByteString -&gt; (Either String a, ByteString)</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Anext"
>next</A
> :: <A HREF="Text-ParserCombinators-Poly-ByteString.html#t%3AParser"
>Parser</A
> Char</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Aeof"
>eof</A
> :: <A HREF="Text-ParserCombinators-Poly-ByteString.html#t%3AParser"
>Parser</A
> ()</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Asatisfy"
>satisfy</A
> :: (Char -&gt; Bool) -&gt; <A HREF="Text-ParserCombinators-Poly-ByteString.html#t%3AParser"
>Parser</A
> Char</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Areparse"
>reparse</A
> :: ByteString -&gt; <A HREF="Text-ParserCombinators-Poly-ByteString.html#t%3AParser"
>Parser</A
> ()</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
>module <A HREF="Text-ParserCombinators-Poly-Base.html"
>Text.ParserCombinators.Poly.Base</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 Parser datatype
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>newtype</SPAN
>  <A NAME="t:Parser"
><A NAME="t%3AParser"
></A
></A
><B
>Parser</B
> a </TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/Poly/ByteString.html#Parser"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>This <TT
>Parser</TT
> datatype is a specialised parsing monad with error
   reporting.  Whereas the standard version can be used for arbitrary
   token types, this version is specialised to ByteString input only.
</TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:P"
><A NAME="v%3AP"
></A
></A
><B
>P</B
> (ByteString -&gt; <A HREF="Text-ParserCombinators-Poly-ByteString.html#t%3AResult"
>Result</A
> ByteString a)</TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:Parser')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:Parser" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
>Monad <A HREF="Text-ParserCombinators-Poly-ByteString.html#t%3AParser"
>Parser</A
></TD
></TR
><TR
><TD CLASS="decl"
>Functor <A HREF="Text-ParserCombinators-Poly-ByteString.html#t%3AParser"
>Parser</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Text-ParserCombinators-Poly-Base.html#t%3APolyParse"
>PolyParse</A
> <A HREF="Text-ParserCombinators-Poly-ByteString.html#t%3AParser"
>Parser</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"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:Result"
><A NAME="t%3AResult"
></A
></A
><B
>Result</B
> z a </TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/Poly/ByteString.html#Result"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>A return type like Either, that distinguishes not only between
   right and wrong answers, but also has commitment, so that a failure
   cannot be undone.  This should only be used for writing very primitive
   parsers - really it is an internal detail of the library.
</TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:Success"
><A NAME="v%3ASuccess"
></A
></A
><B
>Success</B
> z a</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:Failure"
><A NAME="v%3AFailure"
></A
></A
><B
>Failure</B
> z String</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:Committed"
><A NAME="v%3ACommitted"
></A
></A
><B
>Committed</B
> (<A HREF="Text-ParserCombinators-Poly-ByteString.html#t%3AResult"
>Result</A
> z a)</TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:Result')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:Result" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
>Functor (<A HREF="Text-ParserCombinators-Poly-ByteString.html#t%3AResult"
>Result</A
> z)</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:runParser"
><A NAME="v%3ArunParser"
></A
></A
><B
>runParser</B
> ::  <A HREF="Text-ParserCombinators-Poly-ByteString.html#t%3AParser"
>Parser</A
> a -&gt; ByteString -&gt; (Either String a, ByteString)</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/Poly/ByteString.html#runParser"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Apply a parser to an input token sequence.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="2"
><A NAME="2"
>basic parsers
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:next"
><A NAME="v%3Anext"
></A
></A
><B
>next</B
> :: <A HREF="Text-ParserCombinators-Poly-ByteString.html#t%3AParser"
>Parser</A
> Char</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/Poly/ByteString.html#next"
>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:eof"
><A NAME="v%3Aeof"
></A
></A
><B
>eof</B
> :: <A HREF="Text-ParserCombinators-Poly-ByteString.html#t%3AParser"
>Parser</A
> ()</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/Poly/ByteString.html#eof"
>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:satisfy"
><A NAME="v%3Asatisfy"
></A
></A
><B
>satisfy</B
> :: (Char -&gt; Bool) -&gt; <A HREF="Text-ParserCombinators-Poly-ByteString.html#t%3AParser"
>Parser</A
> Char</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/Poly/ByteString.html#satisfy"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="3"
><A NAME="3"
>re-parsing
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:reparse"
><A NAME="v%3Areparse"
></A
></A
><B
>reparse</B
> :: ByteString -&gt; <A HREF="Text-ParserCombinators-Poly-ByteString.html#t%3AParser"
>Parser</A
> ()</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/Poly/ByteString.html#reparse"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Push some tokens back onto the front of the input stream and reparse.
   This is useful e.g. for recursively expanding macros.  When the
   user-parser recognises a macro use, it can lookup the macro
   expansion from the parse state, lex it, and then stuff the
   lexed expansion back down into the parser.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="4"
><A NAME="4"
>Re-export all more general combinators
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
>module <A HREF="Text-ParserCombinators-Poly-Base.html"
>Text.ParserCombinators.Poly.Base</A
></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.4.2</TD
></TR
></TABLE
></BODY
></HTML
>