PageRenderTime 57ms CodeModel.GetById 11ms RepoModel.GetById 1ms app.codeStats 0ms

/fparsec/main/Doc/html/reference/error.html

http://github.com/sandersn/fing
HTML | 955 lines | 932 code | 17 blank | 6 comment | 0 complexity | 26a00c1049e17ca4ac4ce91fcf8ec2e5 MD5 | raw file
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4.  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    5. 

  5.  <title>FParsec.Error</title>
    6. 

  6.  <link rel="stylesheet" type="text/css" media="all" href="../css/style.css" /> 
    7. 

  7.  <link rel="stylesheet" type="text/css" media="screen" href="../css/screen-sidebar.css" title="Sidebar" /> 
    8. 

  8.  <link rel="alternate stylesheet" type="text/css" media="screen" href="../css/screen-no-sidebar.css" title="No sidebar" /> 
    9. 

  9.  <!--[if IE]>
    10. 

  10.  <link rel="stylesheet" type="text/css" media="all" href="../css/style-ie.css" /> 
    11. 

  11.  <![endif]-->
    12. 

  12.  <!--[if IE 6]>
    13. 

  13.  <link rel="stylesheet" type="text/css" media="all" href="../css/style-ie6.css" /> 
    14. 

  14.  <![endif]-->
    15. 

  15.  <link rel="stylesheet" type="text/css" media="print" href="../css/print.css" />
    16. 

  16. </head>
    17. 

  17. <body>
    18. 

  18.  <div id="fixed-layer">
    19. 

  19.  <div id="fixed-wrapper">
    20. 

  20.  <div id="sidebar">
    21. 

  21.   <div id="breadcrumbs-dummy"><span class="breadcrumbs">&nbsp;</span></div>
    22. 

  22.   <div id="nav-tree">
    23. 

  23.    <table class="nav n1">
    24. 

  24.     <tbody class="nav-open n1">
    25. 

  25.      <tr class="nav-entry n1 _1">
    26. 

  26.       <td class="nav-number n1"></td>
    27. 

  27.       <td class="nav-title n1"><a href="../index.html">FParsec Documentation</a></td>
    28. 

  28.      </tr>
    29. 

  29.      <tr class="nav-sub-entries n1 _1">
    30. 

  30.       <td class="nav-sub-entries-number n1"></td>
    31. 

  31.       <td class="nav-sub-entries n1">
    32. 

  32.        <table class="nav n2">
    33. 

  33.         <tbody class="nav-before-open n2">
    34. 

  34.          <tr class="nav-entry n2 _1">
    35. 

  35.           <td class="nav-number n2"><a href="../tutorial.html"><span class="section-number">1</span><span class="nav-space"></span></a></td>
    36. 

  36.           <td class="nav-title n2"><a href="../tutorial.html">Tutorial</a></td>
    37. 

  37.          </tr>
    38. 

  38.         </tbody>
    39. 

  39.         <tbody class="nav-open n2">
    40. 

  40.          <tr class="nav-entry n2 _2">
    41. 

  41.           <td class="nav-number n2"><a href="index.html"><span class="section-number">2</span><span class="nav-space"></span></a></td>
    42. 

  42.           <td class="nav-title n2"><a href="index.html">Reference</a></td>
    43. 

  43.          </tr>
    44. 

  44.          <tr class="nav-sub-entries n2 _2">
    45. 

  45.           <td class="nav-sub-entries-number n2"></td>
    46. 

  46.           <td class="nav-sub-entries n2">
    47. 

  47.            <table class="nav n3">
    48. 

  48.             <tbody class="nav-before-open n3">
    49. 

  49.              <tr class="nav-entry n3 _1">
    50. 

  50.               <td class="nav-number n3"><a href="parser-overview.html"><span class="section-number">1</span><span class="nav-space"></span></a></td>
    51. 

  51.               <td class="nav-title n3"><a href="parser-overview.html">Parser overview</a></td>
    52. 

  52.              </tr>
    53. 

  53.              <tr class="nav-entry n3 _2">
    54. 

  54.               <td class="nav-number n3"><a href="primitives.html"><span class="section-number">2</span><span class="nav-space"></span></a></td>
    55. 

  55.               <td class="nav-title n3"><a href="primitives.html">FParsec.Primitives</a></td>
    56. 

  56.              </tr>
    57. 

  57.              <tr class="nav-entry n3 _3">
    58. 

  58.               <td class="nav-number n3"><a href="charparsers.html"><span class="section-number">3</span><span class="nav-space"></span></a></td>
    59. 

  59.               <td class="nav-title n3"><a href="charparsers.html">FParsec.CharParsers</a></td>
    60. 

  60.              </tr>
    61. 

  61.              <tr class="nav-entry n3 _4">
    62. 

  62.               <td class="nav-number n3">
    63. 

  63.                <a href="operatorprecedenceparser.html"><span class="section-number">4</span><span class="nav-space"></span></a>
    64. 

  64.               </td>
    65. 

  65.               <td class="nav-title n3"><a href="operatorprecedenceparser.html">FParsec.OperatorPrecedenceParser</a></td>
    66. 

  66.              </tr>
    67. 

  67.             </tbody>
    68. 

  68.             <tbody class="nav-open selected n3">
    69. 

  69.              <tr class="nav-entry selected n3 _5">
    70. 

  70.               <td class="nav-number selected n3"><a href="#"><span class="section-number">5</span><span class="nav-space"></span></a></td>
    71. 

  71.               <td class="nav-title selected n3"><a href="#">FParsec.Error</a></td>
    72. 

  72.              </tr>
    73. 

  73.              <tr class="nav-sub-entries selected n3 _5">
    74. 

  74.               <td class="nav-sub-entries-number selected n3"></td>
    75. 

  75.               <td class="nav-sub-entries selected n3">
    76. 

  76.                <table class="nav n4">
    77. 

  77.                 <tbody class="nav-before-open n4">
    78. 

  78.                  <tr class="nav-entry n4 _1">
    79. 

  79.                   <td class="nav-number n4"><a href="#interface"><span class="section-number">1</span><span class="nav-space"></span></a></td>
    80. 

  80.                   <td class="nav-title n4"><a href="#interface">Interface</a></td>
    81. 

  81.                  </tr>
    82. 

  82.                  <tr class="nav-entry n4 _2">
    83. 

  83.                   <td class="nav-number n4"><a href="#members"><span class="section-number">2</span><span class="nav-space"></span></a></td>
    84. 

  84.                   <td class="nav-title n4"><a href="#members">Members</a></td>
    85. 

  85.                  </tr>
    86. 

  86.                 </tbody>
    87. 

  87.                </table>
    88. 

  88.               </td>
    89. 

  89.              </tr>
    90. 

  90.             </tbody>
    91. 

  91.             <tbody class="nav-after-open n3">
    92. 

  92.              <tr class="nav-entry n3 _6">
    93. 

  93.               <td class="nav-number n3"><a href="state.html"><span class="section-number">6</span><span class="nav-space"></span></a></td>
    94. 

  94.               <td class="nav-title n3"><a href="state.html">FParsec.State</a></td>
    95. 

  95.              </tr>
    96. 

  96.              <tr class="nav-entry n3 _7">
    97. 

  97.               <td class="nav-number n3"><a href="position.html"><span class="section-number">7</span><span class="nav-space"></span></a></td>
    98. 

  98.               <td class="nav-title n3"><a href="position.html">FParsec.Position</a></td>
    99. 

  99.              </tr>
    100. 

  100.              <tr class="nav-entry n3 _8">
    101. 

  101.               <td class="nav-number n3"><a href="charstream.html"><span class="section-number">8</span><span class="nav-space"></span></a></td>
    102. 

  102.               <td class="nav-title n3"><a href="charstream.html">FParsec.CharStream</a></td>
    103. 

  103.              </tr>
    104. 

  104.             </tbody>
    105. 

  105.            </table>
    106. 

  106.           </td>
    107. 

  107.          </tr>
    108. 

  108.         </tbody>
    109. 

  109.        </table>
    110. 

  110.       </td>
    111. 

  111.      </tr>
    112. 

  112.     </tbody>
    113. 

  113.    </table>
    114. 

  114.   </div>
    115. 

  115.  </div>
    116. 

  116.  </div>
    117. 

  117.  </div>
    118. 

  118.  <div id="wrapper">   
    119. 

  119.  <div id="main">
    120. 

  120.  <div id="main-content"> 
    121. 

  121.  <div id="breadcrumbs">
    122. 

  122.   <span class="breadcrumbs">
    123. 

  123.    <span id="breadcrumbs-parents"><a href="../index.html">FParsec Documentation</a><span class="breadcrumbs-sep"> > </span><a href="index.html">Reference</a></span><span class="breadcrumbs-sep"> > </span>FParsec.Error
    124. 

  124.   </span>
    125. 

  125.  </div>  
    126. 

  126.  <div class="section s2">
    127. 

  127.   <h1 class="title h2"><span class="section-number">2.5</span> FParsec.Error</h1>
    128. 

  128.   <div id="interface" class="section s3">
    129. 

  129.    <h2 class="title h3"><span class="section-number">2.5.1</span> Interface</h2>
    130. 

  130.    <div class="intro i3">
    131. 

  131.     <div class="para _1">
    132. 

  132. <pre class="code fsharp"><span class="ck">module</span> <span class="ci">FParsec</span><span class="cm">.</span><span class="ci">Error</span>
    133. 

  133. 

  134. <span class="ck">type</span> <a id="interface.ErrorMessage:B:" href="#members.ErrorMessage"><span class="interface-member-marker"><span class="ci">ErrorMessage</span></span></a> <span class="co">=</span>
    135. 

  135.      <span class="cp">|</span> <a id="interface.Expected:B:" href="#members.Expected"><span class="interface-member-marker"><span class="ci">Expected</span></span></a>           <span class="ck">of</span> <span class="ci">string</span>
    136. 

  136.      <span class="cp">|</span> <a id="interface.ExpectedString:B:" href="#members.ExpectedString"><span class="interface-member-marker"><span class="ci">ExpectedString</span></span></a>     <span class="ck">of</span> <span class="ci">string</span>
    137. 

  137.      <span class="cp">|</span> <a id="interface.ExpectedStringCI:B:" href="#members.ExpectedStringCI"><span class="interface-member-marker"><span class="ci">ExpectedStringCI</span></span></a>   <span class="ck">of</span> <span class="ci">string</span>
    138. 

  138.      <span class="cp">|</span> <a id="interface.Unexpected:B:" href="#members.Unexpected"><span class="interface-member-marker"><span class="ci">Unexpected</span></span></a>         <span class="ck">of</span> <span class="ci">string</span>
    139. 

  139.      <span class="cp">|</span> <a id="interface.UnexpectedString:B:" href="#members.UnexpectedString"><span class="interface-member-marker"><span class="ci">UnexpectedString</span></span></a>   <span class="ck">of</span> <span class="ci">string</span>
    140. 

  140.      <span class="cp">|</span> <a id="interface.UnexpectedStringCI:B:" href="#members.UnexpectedStringCI"><span class="interface-member-marker"><span class="ci">UnexpectedStringCI</span></span></a> <span class="ck">of</span> <span class="ci">string</span>
    141. 

  141.      <span class="cp">|</span> <a id="interface.Message:B:" href="#members.Message"><span class="interface-member-marker"><span class="ci">Message</span></span></a>            <span class="ck">of</span> <span class="ci">string</span>
    142. 

  142.      <span class="cp">|</span> <a id="interface.CompoundError:B:" href="#members.CompoundError"><span class="interface-member-marker"><span class="ci">CompoundError</span></span></a>      <span class="ck">of</span> <span class="ci">string</span> <span class="cp">*</span> <a href="position.html"><span class="ci">Position</span></a> <span class="cp">*</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    143. 

  143.      <span class="cp">|</span> <a id="interface.BacktrackPoint:B:" href="#members.BacktrackPoint"><span class="interface-member-marker"><span class="ci">BacktrackPoint</span></span></a>     <span class="ck">of</span> <a href="position.html"><span class="ci">Position</span></a> <span class="cp">*</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    144. 

  144.      <span class="cp">|</span> <a id="interface.OtherError:B:" href="#members.OtherError"><span class="interface-member-marker"><span class="ci">OtherError</span></span></a>         <span class="ck">of</span> <a href="http://msdn.microsoft.com/en-us/library/system.icomparable.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IComparable</span></a>
    145. 

  145. 

  146. <span class="cp">[&lt;</span><span class="ci">CompilationRepresentation</span><span class="cp">(</span><span class="ci">CompilationRepresentationFlags</span><span class="cm">.</span><span class="ci">UseNullAsTrueValue</span><span class="cp">)</span><span class="cp">;</span>
    147. 

  147.   <span class="ci">CustomEquality</span><span class="cp">;</span> <span class="ci">CustomComparison</span><span class="cp">&gt;]</span>
    148. 

  148. <span class="ck">type</span> <a id="interface.ErrorMessageList:B:" href="#members.ErrorMessageList"><span class="interface-member-marker"><span class="ci">ErrorMessageList</span></span></a> <span class="co">=</span>
    149. 

  149.     <span class="cp">|</span> <a id="interface.AddErrorMessage:B:" href="#members.AddErrorMessage"><span class="interface-member-marker"><span class="ci">AddErrorMessage</span></span></a> <span class="ck">of</span> <a href="#members.ErrorMessage"><span class="ci">ErrorMessage</span></a> <span class="cp">*</span> <span class="ci">ErrorMessageList</span>
    150. 

  150.     <span class="cp">|</span> <a id="interface.NoErrorMessages:B:" href="#members.NoErrorMessages"><span class="interface-member-marker"><span class="ci">NoErrorMessages</span></span></a>
    151. 

  151.     <span class="ck">with</span>
    152. 

  152.          <span class="ck">member</span> <a id="interface.ToSet:B:" href="#members.ToSet"><span class="interface-member-marker"><span class="ci">ToSet</span></span></a><span class="cp">:</span> <span class="ci">unit</span> <span class="cr">-&gt;</span> <span class="ci">Set</span><span class="cp">&lt;</span><a href="#members.ErrorMessage"><span class="ci">ErrorMessage</span></a><span class="cp">&gt;</span>
    153. 

  153.          <span class="ck">static</span> <span class="ck">member</span> <a id="interface.OfSeq:B:" href="#members.OfSeq"><span class="interface-member-marker"><span class="ci">OfSeq</span></span></a><span class="cp">:</span> <span class="ci">seq</span><span class="cp">&lt;</span><a href="#members.ErrorMessage"><span class="ci">ErrorMessage</span></a><span class="cp">&gt;</span> <span class="cr">-&gt;</span> <span class="ci">ErrorMessageList</span>
    154. 

  154. 

  155.          <span class="ck">override</span> <span class="ci">Equals</span><span class="cp">:</span> <span class="ci">obj</span> <span class="cr">-&gt;</span> <span class="ci">bool</span>
    156. 

  156.          <span class="ck">override</span> <span class="ci">GetHashCode</span><span class="cp">:</span> <span class="ci">unit</span> <span class="cr">-&gt;</span> <span class="ci">int</span>
    157. 

  157.          <span class="ck">interface</span> <a href="http://msdn.microsoft.com/en-us/library/system.icomparable.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IComparable</span></a>
    158. 

  158. 

  159. <span class="ck">val</span> <a id="interface.expectedError:B:" href="#members.expectedError"><span class="interface-member-marker"><span class="ci">expectedError</span></span></a><span class="cp">:</span>           <span class="ci">string</span> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    160. 

  160. <span class="ck">val</span> <a id="interface.expectedStringError:B:" href="#members.expectedStringError"><span class="interface-member-marker"><span class="ci">expectedStringError</span></span></a><span class="cp">:</span>     <span class="ci">string</span> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    161. 

  161. <span class="ck">val</span> <a id="interface.expectedStringCIError:B:" href="#members.expectedStringCIError"><span class="interface-member-marker"><span class="ci">expectedStringCIError</span></span></a><span class="cp">:</span>   <span class="ci">string</span> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    162. 

  162. <span class="ck">val</span> <a id="interface.unexpectedError:B:" href="#members.unexpectedError"><span class="interface-member-marker"><span class="ci">unexpectedError</span></span></a><span class="cp">:</span>         <span class="ci">string</span> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    163. 

  163. <span class="ck">val</span> <a id="interface.unexpectedStringError:B:" href="#members.unexpectedStringError"><span class="interface-member-marker"><span class="ci">unexpectedStringError</span></span></a><span class="cp">:</span>   <span class="ci">string</span> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    164. 

  164. <span class="ck">val</span> <a id="interface.unexpectedStringCIError:B:" href="#members.unexpectedStringCIError"><span class="interface-member-marker"><span class="ci">unexpectedStringCIError</span></span></a><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    165. 

  165. <span class="ck">val</span> <a id="interface.messageError:B:" href="#members.messageError"><span class="interface-member-marker"><span class="ci">messageError</span></span></a><span class="cp">:</span>            <span class="ci">string</span> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    166. 

  166. <span class="ck">val</span> <a id="interface.otherError:B:" href="#members.otherError"><span class="interface-member-marker"><span class="ci">otherError</span></span></a><span class="cp">:</span>              <span class="ci">obj</span>    <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    167. 

  167. 

  168. <span class="ck">val</span> <a id="interface.compoundError:B:" href="#members.compoundError"><span class="interface-member-marker"><span class="ci">compoundError</span></span></a><span class="cp">:</span>   <span class="ci">string</span> <span class="cr">-&gt;</span> <a href="state.html"><span class="ci">State</span></a><span class="cp">&lt;</span><span class="ctv">'u</span><span class="cp">&gt;</span> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    169. 

  169. <span class="ck">val</span> <a id="interface.backtrackError:B:" href="#members.backtrackError"><span class="interface-member-marker"><span class="ci">backtrackError</span></span></a><span class="cp">:</span>            <a href="state.html"><span class="ci">State</span></a><span class="cp">&lt;</span><span class="ctv">'u</span><span class="cp">&gt;</span> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    170. 

    171. 

  171. <span class="ck">val</span> <a id="interface.concatErrorMessages:B:" href="#members.concatErrorMessages"><span class="interface-member-marker"><span class="ci">concatErrorMessages</span></span></a><span class="cp">:</span>
    172. 

  172.         <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    173. 

  173. 

  174. <span class="ck">val</span> <span class="ck">inline</span> <a id="interface.mergeErrors:B:" href="#members.mergeErrors"><span class="interface-member-marker"><span class="ci">mergeErrors</span></span></a><span class="cp">:</span>
    175. 

  175.         <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    176. 

  176. 

  177. <span class="ck">val</span> <a id="interface.mergeErrorsIfNeeded:B:" href="#members.mergeErrorsIfNeeded"><span class="interface-member-marker"><span class="ci">mergeErrorsIfNeeded</span></span></a><span class="cp">:</span>
    178. 

  178.         <span class="ci">oldState</span><span class="cp">:</span> <a href="state.html"><span class="ci">State</span></a><span class="cp">&lt;</span><span class="ctv">'u</span><span class="cp">&gt;</span> <span class="cr">-&gt;</span> <span class="ci">oldError</span><span class="cp">:</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    179. 

  179.      <span class="cr">-&gt;</span> <span class="ci">newState</span><span class="cp">:</span> <a href="state.html"><span class="ci">State</span></a><span class="cp">&lt;</span><span class="ctv">'u</span><span class="cp">&gt;</span> <span class="cr">-&gt;</span> <span class="ci">newError</span><span class="cp">:</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    180. 

  180.      <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    181. 

  181. 

  182. <span class="ck">val</span> <a id="interface.mergeErrorsIfNeeded3:B:" href="#members.mergeErrorsIfNeeded3"><span class="interface-member-marker"><span class="ci">mergeErrorsIfNeeded3</span></span></a><span class="cp">:</span>
    183. 

  183.         <span class="ci">oldestState</span><span class="cp">:</span> <a href="state.html"><span class="ci">State</span></a><span class="cp">&lt;</span><span class="ctv">'u</span><span class="cp">&gt;</span> <span class="cr">-&gt;</span> <span class="ci">oldestError</span><span class="cp">:</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    184. 

  184.      <span class="cr">-&gt;</span> <span class="ci">oldState</span><span class="cp">:</span>    <a href="state.html"><span class="ci">State</span></a><span class="cp">&lt;</span><span class="ctv">'u</span><span class="cp">&gt;</span> <span class="cr">-&gt;</span> <span class="ci">oldError</span><span class="cp">:</span>    <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    185. 

  185.      <span class="cr">-&gt;</span> <span class="ci">newState</span><span class="cp">:</span>    <a href="state.html"><span class="ci">State</span></a><span class="cp">&lt;</span><span class="ctv">'u</span><span class="cp">&gt;</span> <span class="cr">-&gt;</span> <span class="ci">newError</span><span class="cp">:</span>    <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    186. 

  186.      <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    187. 

  187. 

  188. <span class="cp">[&lt;</span><span class="ci">Sealed</span><span class="cp">&gt;]</span>
    189. 

  189. <span class="ck">type</span> <a id="interface.ParserError:B:" href="#members.ParserError"><span class="interface-member-marker"><span class="ci">ParserError</span></span></a> <span class="co">=</span>
    190. 

  190.   <a id="interface.new:B:" href="#members.new"><span class="interface-member-marker"><span class="ck">new</span></span></a><span class="cp">:</span> <a href="position.html"><span class="ci">Position</span></a> <span class="cp">*</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-&gt;</span> <span class="ci">ParserError</span>
    191. 

  191. 

  192.   <span class="ck">member</span> <a id="interface.Position:B:" href="#members.Position"><span class="interface-member-marker"><span class="ci">Position</span></span></a><span class="cp">:</span> <a href="position.html"><span class="ci">Position</span></a>
    193. 

  193.   <span class="ck">member</span> <a id="interface.member-ErrorMessageList:B:" href="#members.member-ErrorMessageList"><span class="interface-member-marker"><span class="ci">ErrorMessageList</span></span></a><span class="cp">:</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    194. 

  194. <a id="interface.ToString:47:WriteTo"></a>
    195. 

  195.   <span class="ck">override</span> <a id="interface.ToString:B:" href="#members.ToString"><span class="interface-member-marker"><span class="ci">ToString</span></span></a><span class="cp">:</span> <span class="ci">unit</span> <span class="cr">-&gt;</span> <span class="ci">string</span>
    196. 

  196.   <span class="ck">member</span> <a id="interface.ToString_CharStream:B:" href="#members.ToString_CharStream"><span class="interface-member-marker"><span class="ci">ToString</span></span></a><span class="cp">:</span> <span class="ci">streamWhereErrorOccurred</span><span class="cp">:</span> <a href="charstream.html"><span class="ci">CharStream</span></a> <span class="cr">-&gt;</span> <span class="ci">string</span>
    197. 

  197. 

  198.   <span class="ck">member</span> <a id="interface.WriteTo_stream:B:" href="#members.WriteTo_stream"><span class="interface-member-marker"><span class="ci">WriteTo</span></span></a><span class="cp">:</span>
    199. 

  199.            <span class="ci">textWriter</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">TextWriter</span></a>
    200. 

  200.          <span class="cp">*</span> <span class="ci">streamWhereErrorOccurred</span><span class="cp">:</span> <a href="charstream.html"><span class="ci">CharStream</span></a>
    201. 

  201.          <span class="cp">*</span> <span class="cp">?</span><span class="ci">columnWidth</span><span class="cp">:</span> <span class="ci">int</span>
    202. 

  202.          <span class="cp">*</span> <span class="cp">?</span><span class="ci">initialIndentation</span><span class="cp">:</span> <span class="ci">string</span> <span class="cp">*</span> <span class="cp">?</span><span class="ci">indentationIncrement</span><span class="cp">:</span> <span class="ci">string</span>
    203. 

  203.          <span class="cr">-&gt;</span> <span class="ci">unit</span>
    204. 

  204. 

  205.   <span class="ck">member</span> <a id="interface.WriteTo_getStreamByName:B:" href="#members.WriteTo_getStreamByName"><span class="interface-member-marker"><span class="ci">WriteTo</span></span></a><span class="cp">:</span>
    206. 

  206.            <span class="ci">textWriter</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">TextWriter</span></a>
    207. 

  207.          <span class="cp">*</span> <span class="ci">getStreamByName</span><span class="cp">:</span> <span class="cp">(</span><span class="ci">string</span> <span class="cr">-&gt;</span> <a href="charstream.html"><span class="ci">CharStream</span></a><span class="cp">)</span>
    208. 

  208.          <span class="cp">*</span> <span class="cp">?</span><span class="ci">columnWidth</span><span class="cp">:</span> <span class="ci">int</span>
    209. 

  209.          <span class="cp">*</span> <span class="cp">?</span><span class="ci">initialIndentation</span><span class="cp">:</span> <span class="ci">string</span> <span class="cp">*</span> <span class="cp">?</span><span class="ci">indentationIncrement</span><span class="cp">:</span> <span class="ci">string</span>
    210. 

  210.          <span class="cr">-&gt;</span> <span class="ci">unit</span>
    211. 

  211. 

  212.   <span class="ck">member</span> <a id="interface.WriteTo:B:" href="#members.WriteTo"><span class="interface-member-marker"><span class="ci">WriteTo</span></span></a><span class="cp">:</span>
    213. 

  213.            <span class="ci">textWriter</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">TextWriter</span></a>
    214. 

  214.          <span class="cp">*</span> <span class="cp">?</span><span class="ci">positionPrinter</span><span class="cp">:</span>
    215. 

  215.              <span class="cp">(</span><a href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">TextWriter</span></a> <span class="cr">-&gt;</span> <a href="position.html"><span class="ci">Position</span></a> <span class="cr">-&gt;</span> <span class="ci">string</span> <span class="cr">-&gt;</span> <span class="ci">int</span> <span class="cr">-&gt;</span> <span class="ci">unit</span><span class="cp">)</span>
    216. 

  216.          <span class="cp">*</span> <span class="cp">?</span><span class="ci">columnWidth</span><span class="cp">:</span> <span class="ci">int</span>
    217. 

  217.          <span class="cp">*</span> <span class="cp">?</span><span class="ci">initialIndentation</span><span class="cp">:</span> <span class="ci">string</span> <span class="cp">*</span> <span class="cp">?</span><span class="ci">indentationIncrement</span><span class="cp">:</span> <span class="ci">string</span>
    218. 

  218.          <span class="cr">-&gt;</span> <span class="ci">unit</span>
    219. 

  219. 

  220.   <span class="ck">override</span> <span class="ci">Equals</span><span class="cp">:</span> <span class="ci">obj</span> <span class="cr">-&gt;</span> <span class="ci">bool</span>
    221. 

  221.   <span class="ck">override</span> <span class="ci">GetHashCode</span><span class="cp">:</span> <span class="ci">unit</span> <span class="cr">-&gt;</span> <span class="ci">int</span>
    222. 

  222.   <span class="ck">interface</span> <a href="http://msdn.microsoft.com/en-us/library/system.icomparable.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IComparable</span></a>
    223. 

  223. </pre>
    224. 

  224.     </div>
    225. 

  225.    </div>
    226. 

  226.   </div>
    227. 

  227.   <div id="members" class="section s3">
    228. 

  228.    <h2 class="title h3"><span class="section-number">2.5.2</span> Members</h2>
    229. 

  229.    <div class="intro i3">
    230. 

  230.     <div class="para _1">
    231. 

  231.      <div class="interface-members">
    232. 

  232.       <div class="interface-member _1" id="members.ErrorMessage">
    233. 

  233.        <div class="interface-member-code">
    234. 

  234.         <a class="interface-member-backlink" href="#interface.ErrorMessage:B:">⇧</a>
    235. 

  235. <pre class="code fsharp"><span class="ck">type</span> <span class="interface-member-marker"><span class="ci">ErrorMessage</span></span></pre>
    236. 

  236.        </div>
    237. 

  237.        <div class="interface-member-description">
    238. 

  238.         <p class="para _1">
    239. 

  239.          This union type represents an individual error message within the <code class="fsharp"><a href="#members.ErrorMessageList"><span
    240. 

  240.          class="ci">ErrorMessageList</span></a></code> returned by a <code class="fsharp"><a href="primitives.html#members.Parser"><span
    241. 

  241.          class="ci">Parser</span></a></code> function.
    242. 

  242.         </p>
    243. 

  243.         <p class="para _2">
    244. 

  244.          <code class="fsharp"><span class="ci">ErrorMessage</span></code> values are always associated with a particular input stream position. For
    245. 

  245.          example, the error messages of the <code class="fsharp"><a href="#members.ErrorMessageList"><span
    246. 

  246.          class="ci">ErrorMessageList</span></a></code> stored in the <code class="fsharp"><a href="primitives.html#members.Reply"><span
    247. 

  247.          class="ci">Reply</span></a><span class="cp">&lt;</span><span class="ci">_</span><span class="cp">,</span><span class="ci">_</span><span
    248. 

  248.          class="cp">&gt;</span><span class="cp">.</span><a href="primitives.html#members.Error"><span class="ci">Error</span></a></code> field
    249. 

  249.          describe an error at the position of the <code class="fsharp"><a href="primitives.html#members.Reply"><span class="ci">Reply</span></a><span
    250. 

  250.          class="cp">&lt;</span><span class="ci">_</span><span class="cp">,</span><span class="ci">_</span><span class="cp">&gt;</span><span
    251. 

  251.          class="cp">.</span><a href="state.html"><span class="ci">State</span></a></code> value. The <code class="fsharp"><a
    252. 

  252.          href="#members.ParserError"><span class="ci">ParserError</span></a></code> type is a convenient container type for binding together an <code
    253. 

  253.          class="fsharp"><a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with its associated position.
    254. 

  254.         </p>
    255. 

  255.         <p class="para _3"><code class="fsharp"><span class="ci">ErrorMessage</span></code> has the following union cases:</p>
    256. 

  256.         <div class="para _4">
    257. 

  257.          <div class="interface-members">
    258. 

  258.           <div class="interface-member _1" id="members.Expected">
    259. 

  259.            <div class="interface-member-code">
    260. 

  260.             <a class="interface-member-backlink" href="#interface.Expected:B:">⇧</a>
    261. 

  261. <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">Expected</span></span> <span class="ck">of</span> <span class="ci">string</span>
    262. 

  262. </pre>
    263. 

  263.            </div>
    264. 

  264.            <div class="interface-member-description">
    265. 

  265.             <p class="para _1">
    266. 

  266.              Parsers report this <code class="fsharp"><span class="ci">ErrorMessage</span></code> when the input does not match the expected input.
    267. 

  267.              The string argument describes the expected input.
    268. 

  268.             </p>
    269. 

  269.             <p class="para _2">
    270. 

  270.              This error message can be generated with the labeling operator <code class="fsharp"><a href="primitives.html#members.:60::63::62:"><span
    271. 

  271.              class="co">&lt;?&gt;</span></a></code>.
    272. 

  272.             </p>
    273. 

  273.            </div>
    274. 

  274.           </div>
    275. 

  275.           <div class="interface-member _2" id="members.ExpectedString">
    276. 

  276.            <div class="interface-member-code">
    277. 

  277.             <a class="interface-member-backlink" href="#interface.ExpectedString:B:">⇧</a>
    278. 

  278. <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">ExpectedString</span></span> <span class="ck">of</span> <span class="ci">string</span>
    279. 

  279. </pre>
    280. 

  280.            </div>
    281. 

  281.            <div class="interface-member-description">
    282. 

  282.             <p class="para _1">
    283. 

  283.              Parsers report this <code class="fsharp"><span class="ci">ErrorMessage</span></code> when the input does not match an expected string
    284. 

  284.              constant. The constructor argument is the expected string constant.
    285. 

  285.             </p>
    286. 

  286.             <p class="para _2">
    287. 

  287.              This <code class="fsharp"><span class="ci">ErrorMessage</span></code> is mainly generated by the <code class="fsharp"><a
    288. 

  288.              href="charparsers.html#members.pchar"><span class="ci">pchar</span></a></code> and <code class="fsharp"><a
    289. 

  289.              href="charparsers.html#members.pstring"><span class="ci">pstring</span></a></code> parsers and its variants.
    290. 

  290.             </p>
    291. 

  291.            </div>
    292. 

  292.           </div>
    293. 

  293.           <div class="interface-member _3" id="members.ExpectedStringCI">
    294. 

  294.            <div class="interface-member-code">
    295. 

  295.             <a class="interface-member-backlink" href="#interface.ExpectedStringCI:B:">⇧</a>
    296. 

  296. <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">ExpectedStringCI</span></span> <span class="ck">of</span> <span class="ci">string</span>
    297. 

  297. </pre>
    298. 

  298.            </div>
    299. 

  299.            <div class="interface-member-description">
    300. 

  300.             <p class="para _1">
    301. 

  301.              Parsers report this <code class="fsharp"><span class="ci">ErrorMessage</span></code> when the input does not match an expected
    302. 

  302.              case‐insensitive string constant. The constructor argument is the expected string constant.
    303. 

  303.             </p>
    304. 

  304.             <p class="para _2">
    305. 

  305.              This <code class="fsharp"><span class="ci">ErrorMessage</span></code> is mainly generated by the <code class="fsharp"><a
    306. 

  306.              href="charparsers.html#members.pstringCI"><span class="ci">pstringCI</span></a></code> parsers and its variants.
    307. 

  307.             </p>
    308. 

  308.            </div>
    309. 

  309.           </div>
    310. 

  310.           <div class="interface-member _4" id="members.Unexpected">
    311. 

  311.            <div class="interface-member-code">
    312. 

  312.             <a class="interface-member-backlink" href="#interface.Unexpected:B:">⇧</a>
    313. 

  313. <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">Unexpected</span></span> <span class="ck">of</span> <span class="ci">string</span>
    314. 

  314. </pre>
    315. 

  315.            </div>
    316. 

  316.            <div class="interface-member-description">
    317. 

  317.             <p class="para _1">
    318. 

  318.              Parsers report this <code class="fsharp"><span class="ci">ErrorMessage</span></code> when they encounter some unexpected input. The
    319. 

  319.              string argument describes the unexpected input.
    320. 

  320.             </p>
    321. 

  321.             <p class="para _2">
    322. 

  322.              This <code class="fsharp"><span class="ci">ErrorMessage</span></code> is mainly generated by the <code class="fsharp"><a
    323. 

  323.              href="primitives.html#members.notFollowedByL"><span class="ci">notFollowedByL</span></a></code> primitive.
    324. 

  324.             </p>
    325. 

  325.            </div>
    326. 

  326.           </div>
    327. 

  327.           <div class="interface-member _5" id="members.UnexpectedString">
    328. 

  328.            <div class="interface-member-code">
    329. 

  329.             <a class="interface-member-backlink" href="#interface.UnexpectedString:B:">⇧</a>
    330. 

  330. <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">UnexpectedString</span></span> <span class="ck">of</span> <span class="ci">string</span>
    331. 

  331. </pre>
    332. 

  332.            </div>
    333. 

  333.            <div class="interface-member-description">
    334. 

  334.             <p class="para _1">
    335. 

  335.              Parsers report this <code class="fsharp"><span class="ci">ErrorMessage</span></code> when they encounter an unexpected string constant.
    336. 

  336.              The constructor argument is the unexpected string.
    337. 

  337.             </p>
    338. 

  338.             <p class="para _2">
    339. 

  339.              This <code class="fsharp"><span class="ci">ErrorMessage</span></code> is mainly generated by the <code class="fsharp"><a
    340. 

  340.              href="charparsers.html#members.notFollowedByChar"><span class="ci">notFollowedByChar</span></a></code> and <code class="fsharp"><a
    341. 

  341.              href="charparsers.html#members.notFollowedByString"><span class="ci">notFollowedByString</span></a></code> parsers.
    342. 

  342.             </p>
    343. 

  343.            </div>
    344. 

  344.           </div>
    345. 

  345.           <div class="interface-member _6" id="members.UnexpectedStringCI">
    346. 

  346.            <div class="interface-member-code">
    347. 

  347.             <a class="interface-member-backlink" href="#interface.UnexpectedStringCI:B:">⇧</a>
    348. 

  348. <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">UnexpectedStringCI</span></span> <span class="ck">of</span> <span class="ci">string</span>
    349. 

  349. </pre>
    350. 

  350.            </div>
    351. 

  351.            <div class="interface-member-description">
    352. 

  352.             <p class="para _1">
    353. 

  353.              Parsers report this <code class="fsharp"><span class="ci">ErrorMessage</span></code> when they encounter an unexpected case‐insensitive
    354. 

  354.              string constant. The constructor argument is the unexpected string.
    355. 

  355.             </p>
    356. 

  356.             <p class="para _2">
    357. 

  357.              This <code class="fsharp"><span class="ci">ErrorMessage</span></code> is mainly generated by the <code class="fsharp"><a
    358. 

  358.              href="charparsers.html#members.notFollowedByStringCI"><span class="ci">notFollowedByStringCI</span></a></code> parsers.
    359. 

  359.             </p>
    360. 

  360.            </div>
    361. 

  361.           </div>
    362. 

  362.           <div class="interface-member _7" id="members.Message">
    363. 

  363.            <div class="interface-member-code">
    364. 

  364.             <a class="interface-member-backlink" href="#interface.Message:B:">⇧</a>
    365. 

  365. <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">Message</span></span> <span class="ck">of</span> <span class="ci">string</span>
    366. 

  366. </pre>
    367. 

  367.            </div>
    368. 

  368.            <div class="interface-member-description">
    369. 

  369.             <p class="para _1">
    370. 

  370.              Parsers report this <code class="fsharp"><span class="ci">ErrorMessage</span></code> when an the error does not fit into the other
    371. 

  371.              categories. The string argument contains the error message.
    372. 

  372.             </p>
    373. 

  373.             <p class="para _2">
    374. 

  374.              This error message can be generated with the <code class="fsharp"><a href="primitives.html#members.fail"><span
    375. 

  375.              class="ci">fail</span></a></code> and <code class="fsharp"><a href="primitives.html#members.failFatally"><span
    376. 

  376.              class="ci">failFatally</span></a></code> primitives.
    377. 

  377.             </p>
    378. 

  378.            </div>
    379. 

  379.           </div>
    380. 

  380.           <div class="interface-member _8" id="members.CompoundError">
    381. 

  381.            <div class="interface-member-code">
    382. 

  382.             <a class="interface-member-backlink" href="#interface.CompoundError:B:">⇧</a>
    383. 

  383. <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">CompoundError</span></span> <span class="ck">of</span> <span class="ci">string</span> <span class="cp">*</span> <a href="position.html"><span class="ci">Position</span></a> <span class="cp">*</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    384. 

  384. </pre>
    385. 

  385.            </div>
    386. 

  386.            <div class="interface-member-description">
    387. 

  387.             <p class="para _1">
    388. 

  388.              Parsers report this <code class="fsharp"><span class="ci">ErrorMessage</span></code> when a &#x201C;compound&#x201D; failed to parse. The
    389. 

  389.              constructor arguments are a label for the compound parser and the error (<code class="fsharp"><a href="#members.Position"><span
    390. 

  390.              class="ci">Position</span></a></code> + <code class="fsharp"><a href="#members.ErrorMessageList"><span
    391. 

  391.              class="ci">ErrorMessageList</span></a></code>) that caused the compound to fail to parse.
    392. 

  392.             </p>
    393. 

  393.             <p class="para _2">
    394. 

  394.              This error message is mainly generated by the compound‐labelling operator <code class="fsharp"><a
    395. 

  395.              href="primitives.html#members.:60::63::63::62:"><span class="co">&lt;??&gt;</span></a></code>.
    396. 

  396.             </p>
    397. 

  397.            </div>
    398. 

  398.           </div>
    399. 

  399.           <div class="interface-member _9" id="members.BacktrackPoint">
    400. 

  400.            <div class="interface-member-code">
    401. 

  401.             <a class="interface-member-backlink" href="#interface.BacktrackPoint:B:">⇧</a>
    402. 

  402. <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">BacktrackPoint</span></span> <span class="ck">of</span> <a href="position.html"><span class="ci">Position</span></a> <span class="cp">*</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    403. 

  403. </pre>
    404. 

  404.            </div>
    405. 

  405.            <div class="interface-member-description">
    406. 

  406.             <p class="para _1">
    407. 

  407.              Parsers report this <code class="fsharp"><span class="ci">ErrorMessage</span></code> when they backtracked after an error occurred. The
    408. 

  408.              constructor argument is the error (<code class="fsharp"><a href="#members.Position"><span class="ci">Position</span></a></code> + <code
    409. 

  409.              class="fsharp"><a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code>) that occurred before the
    410. 

  410.              backtracking.
    411. 

  411.             </p>
    412. 

  412.             <p class="para _2">
    413. 

  413.              This error message is mainly generated by the <code class="fsharp"><a href="primitives.html#members.attempt"><span
    414. 

  414.              class="ci">attempt</span></a></code>, <code class="fsharp"><a href="primitives.html#members.:62::62::63:"><span
    415. 

  415.              class="co">&gt;&gt;?</span></a></code> and <code class="fsharp"><a href="primitives.html#members.:.::62::62::63:"><span
    416. 

  416.              class="co">.&gt;&gt;?</span></a></code> primitives.
    417. 

  417.             </p>
    418. 

  418.            </div>
    419. 

  419.           </div>
    420. 

  420.           <div class="interface-member _0" id="members.OtherError">
    421. 

  421.            <div class="interface-member-code">
    422. 

  422.             <a class="interface-member-backlink" href="#interface.OtherError:B:">⇧</a>
    423. 

  423. <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">OtherError</span></span> <span class="ck">of</span> <a href="http://msdn.microsoft.com/en-us/library/system.icomparable.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IComparable</span></a>
    424. 

  424. </pre>
    425. 

  425.            </div>
    426. 

  426.            <div class="interface-member-description">
    427. 

  427.             <p class="para _1">
    428. 

  428.              User‐defined parsers can return this <code class="fsharp"><span class="ci">ErrorMessage</span></code> to report application‐specific
    429. 

  429.              error data. The object argument contains the error data.
    430. 

  430.             </p>
    431. 

  431.             <p class="para _2">
    432. 

  432.              To display <code class="fsharp"><span class="ci">OtherError</span></code> values in error messages, you will have to define your own
    433. 

  433.              error printer, as <code class="fsharp"><a href="#members.ParserError"><span class="ci">ParserError</span></a><span class="cm">.</span><a
    434. 

  434.              href="#interface.ToString:47:WriteTo"><span class="ci">ToString</span><span class="co">/</span><span class="ci">WriteTo</span></a></code>
    435. 

  435.              ignores them.
    436. 

  436.             </p>
    437. 

  437.            </div>
    438. 

  438.           </div>
    439. 

  439.          </div>
    440. 

  440.         </div>
    441. 

  441.        </div>
    442. 

  442.       </div>
    443. 

  443.       <div class="interface-member _2" id="members.ErrorMessageList">
    444. 

  444.        <div class="interface-member-code">
    445. 

  445.         <a class="interface-member-backlink" href="#interface.ErrorMessageList:B:">⇧</a>
    446. 

  446. <pre class="code fsharp"><span class="ck">type</span> <span class="interface-member-marker"><span class="ci">ErrorMessageList</span></span></pre>
    447. 

  447.        </div>
    448. 

  448.        <div class="interface-member-description">
    449. 

  449.         <p class="para _1">
    450. 

  450.          This union type represents a list of error messages in which the order of the messages carries no meaning and any duplicates and empty
    451. 

  451.          messages are ignored. Essentially, an <code class="fsharp"><span class="ci">ErrorMessageList</span></code> is <em>constructed as a list, but
    452. 

  452.          interpreted as a set</em>.
    453. 

  453.         </p>
    454. 

  454.         <p class="para _2">
    455. 

  455.          All <code class="fsharp"><a href="#members.ErrorMessage"><span class="ci">ErrorMessage</span></a></code> values in an <code
    456. 

  456.          class="fsharp"><span class="ci">ErrorMessageList</span></code> are associated with the same input stream position. For example, the error
    457. 

  457.          messages stored in the <code class="fsharp"><a href="primitives.html#members.Reply"><span class="ci">Reply</span></a><span
    458. 

  458.          class="cp">&lt;</span><span class="ci">_</span><span class="cp">,</span><span class="ci">_</span><span class="cp">&gt;</span><span
    459. 

  459.          class="cp">.</span><a href="primitives.html#members.Error"><span class="ci">Error</span></a></code> field describe an error at the position
    460. 

  460.          of the <code class="fsharp"><a href="primitives.html#members.Reply"><span class="ci">Reply</span></a><span class="cp">&lt;</span><span
    461. 

  461.          class="ci">_</span><span class="cp">,</span><span class="ci">_</span><span class="cp">&gt;</span><span class="cp">.</span><a
    462. 

  462.          href="state.html"><span class="ci">State</span></a></code> value. The <code class="fsharp"><a href="#members.ParserError"><span
    463. 

  463.          class="ci">ParserError</span></a></code> type is a convenient container type for binding together an <code class="fsharp"><span
    464. 

  464.          class="ci">ErrorMessageList</span></code> with its associated position.
    465. 

  465.         </p>
    466. 

  466.         <p class="para _3">
    467. 

  467.          The easiest way to process an <code class="fsharp"><span class="ci">ErrorMessageList</span></code> as a set is to convert it into an actual
    468. 

  468.          set by using the <code class="fsharp"><a href="#members.ToSet"><span class="ci">ToSet</span></a></code> member. For example, the <code
    469. 

  469.          class="fsharp"><a href="#members.ParserError"><span class="ci">ParserError</span></a><span class="cm">.</span><a
    470. 

  470.          href="#members.WriteTo"><span class="ci">WriteTo</span></a></code> method uses this method to filter out duplicates before printing out the
    471. 

  471.          messages.
    472. 

  472.         </p>
    473. 

  473.         <p class="para _4">
    474. 

  474.          In order to enforce set semantics in comparison operations, the <code class="fsharp"><span class="ci">ErrorMessageList</span></code>
    475. 

  475.          overrides the <code class="fsharp"><span class="ci">Equals</span></code>, <code class="fsharp"><span class="ci">GetHashCode</span></code> and
    476. 

  476.          <code class="fsharp"><span class="ci">CompareTo</span></code> methods.
    477. 

  477.         </p>
    478. 

  478.         <div class="para _5">
    479. 

  479.          <div class="interface-members">
    480. 

  480.           <div class="interface-member _1" id="members.AddErrorMessage">
    481. 

  481.            <div class="interface-member-code">
    482. 

  482.             <a class="interface-member-backlink" href="#interface.AddErrorMessage:B:">⇧</a>
    483. 

  483. <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">AddErrorMessage</span></span> <span class="ck">of</span> <a href="#members.ErrorMessage"><span class="ci">ErrorMessage</span></a> <span class="cp">*</span> <span class="ci">ErrorMessageList</span>
    484. 

  484. </pre>
    485. 

  485.            </div>
    486. 

  486.            <div class="interface-member-description">
    487. 

  487.             <p class="para _1">
    488. 

  488.              Creates a new <code class="fsharp"><span class="ci">ErrorMessageList</span></code> with the given &#x201C;head&#x201D; and
    489. 

  489.              &#x201C;tail&#x201D;.
    490. 

  490.             </p>
    491. 

  491.             <div class="para _2">
    492. 

  492.              <p>For example,</p>
    493. 

  493. <pre class="code fsharp"><span class="ci">AddErrorMessage</span><span class="cp">(</span><a href="#members.Expected"><span class="ci">Expected</span></a> <span class="cs"><span class="left-delimiter">"</span>a<span class="right-delimiter">"</span></span><span class="cp">,</span>
    494. 

  494.                 <span class="ci">AddErrorMessage</span><span class="cp">(</span><a href="#members.Expected"><span class="ci">Expected</span></a> <span class="cs"><span class="left-delimiter">"</span>b<span class="right-delimiter">"</span></span><span class="cp">,</span> <a href="#members.NoErrorMessages"><span class="ci">NoErrorMessages</span></a><span class="cp">)</span><span class="cp">)</span>
    495. 

  495. </pre>
    496. 

  496.              <p>creates an <code class="fsharp"><span class="ci">ErrorMessageList</span></code> with two error messages.</p>
    497. 

  497.             </div>
    498. 

  498.            </div>
    499. 

  499.           </div>
    500. 

  500.           <div class="interface-member _2" id="members.NoErrorMessages">
    501. 

  501.            <div class="interface-member-code">
    502. 

  502.             <a class="interface-member-backlink" href="#interface.NoErrorMessages:B:">⇧</a>
    503. 

  503. <pre class="code fsharp"><span class="cp">|</span> <span class="interface-member-marker"><span class="ci">NoErrorMessages</span></span>
    504. 

  504. </pre>
    505. 

  505.            </div>
    506. 

  506.            <div class="interface-member-description">
    507. 

  507.             <p class="para _1">
    508. 

  508.              The empty <code class="fsharp"><span class="ci">ErrorMessageList</span></code>. This value is represented as <code class="fsharp"><span
    509. 

  509.              class="cnu">null</span></code>.
    510. 

  510.             </p>
    511. 

  511.            </div>
    512. 

  512.           </div>
    513. 

  513.           <div class="interface-member _3" id="members.ToSet">
    514. 

  514.            <div class="interface-member-code">
    515. 

  515.             <a class="interface-member-backlink" href="#interface.ToSet:B:">⇧</a>
    516. 

  516. <pre class="code fsharp"><span class="ck">member</span> <span class="interface-member-marker"><span class="ci">ToSet</span></span><span class="cp">:</span> <span class="ci">unit</span> <span class="cr">-&gt;</span> <span class="ci">Set</span><span class="cp">&lt;</span><a href="#members.ErrorMessage"><span class="ci">ErrorMessage</span></a><span class="cp">&gt;</span>
    517. 

  517. </pre>
    518. 

  518.            </div>
    519. 

  519.            <div class="interface-member-description">
    520. 

  520.             <p class="para _1">
    521. 

  521.              Converts the <code class="fsharp"><span class="ci">ErrorMessageList</span></code> to a <code class="fsharp"><span
    522. 

  522.              class="ci">Set</span><span class="cp">&lt;</span><span class="ci">ErrorMessageList</span><span class="cp">&gt;</span></code>. Duplicate
    523. 

  523.              error messages and empty <code class="fsharp"><a href="#members.Expected"><span class="ci">Expected</span></a></code>, <code
    524. 

  524.              class="fsharp"><a href="#members.Unexpected"><span class="ci">Unexpected</span></a></code> and <code class="fsharp"><a
    525. 

  525.              href="#members.Message"><span class="ci">Message</span></a></code> messages are filtered out when the list is converted to a set.
    526. 

  526.             </p>
    527. 

  527.            </div>
    528. 

  528.           </div>
    529. 

  529.           <div class="interface-member _4" id="members.OfSeq">
    530. 

  530.            <div class="interface-member-code">
    531. 

  531.             <a class="interface-member-backlink" href="#interface.OfSeq:B:">⇧</a>
    532. 

  532. <pre class="code fsharp"><span class="ck">static</span> <span class="ck">member</span> <span class="interface-member-marker"><span class="ci">OfSeq</span></span><span class="cp">:</span> <span class="ci">seq</span><span class="cp">&lt;</span><a href="#members.ErrorMessage"><span class="ci">ErrorMessage</span></a><span class="cp">&gt;</span> <span class="cr">-&gt;</span> <span class="ci">ErrorMessageList</span>
    533. 

  533. </pre>
    534. 

  534.            </div>
    535. 

  535.            <div class="interface-member-description">
    536. 

  536.             <p class="para _1">
    537. 

  537.              Converts a sequence of <code class="fsharp"><a href="#members.ErrorMessage"><span class="ci">ErrorMessage</span></a></code> values into
    538. 

  538.              an <code class="fsharp"><span class="ci">ErrorMessageList</span></code>.
    539. 

  539.             </p>
    540. 

  540.            </div>
    541. 

  541.           </div>
    542. 

  542.          </div>
    543. 

  543.         </div>
    544. 

  544.        </div>
    545. 

  545.       </div>
    546. 

  546.       <div class="interface-member _3" id="members.expectedError">
    547. 

  547.        <div class="interface-member-code">
    548. 

  548.         <a class="interface-member-backlink" href="#interface.expectedError:B:">⇧</a>
    549. 

  549. <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">expectedError</span></span><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    550. 

  550. </pre>
    551. 

  551.        </div>
    552. 

  552.        <div class="interface-member-description">
    553. 

  553.         <p class="para _1">
    554. 

  554.          <code class="fsharp"><span class="ci">expectedError</span> <span class="ci">label</span></code> creates an <code class="fsharp"><a
    555. 

  555.          href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a
    556. 

  556.          href="#members.Expected"><span class="ci">Expected</span></a> <span class="ci">label</span></code> message.
    557. 

  557.         </p>
    558. 

  558.        </div>
    559. 

  559.       </div>
    560. 

  560.       <div class="interface-member _4" id="members.expectedStringError">
    561. 

  561.        <div class="interface-member-code">
    562. 

  562.         <a class="interface-member-backlink" href="#interface.expectedStringError:B:">⇧</a>
    563. 

  563. <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">expectedStringError</span></span><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    564. 

  564. </pre>
    565. 

  565.        </div>
    566. 

  566.        <div class="interface-member-description">
    567. 

  567.         <p class="para _1">
    568. 

  568.          <code class="fsharp"><span class="ci">expectedStringError</span> <span class="ci">str</span></code> creates an <code class="fsharp"><a
    569. 

  569.          href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a
    570. 

  570.          href="#members.ExpectedString"><span class="ci">ExpectedString</span></a> <span class="ci">str</span></code> message.
    571. 

  571.         </p>
    572. 

  572.        </div>
    573. 

  573.       </div>
    574. 

  574.       <div class="interface-member _5" id="members.expectedStringCIError">
    575. 

  575.        <div class="interface-member-code">
    576. 

  576.         <a class="interface-member-backlink" href="#interface.expectedStringCIError:B:">⇧</a>
    577. 

  577. <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">expectedStringCIError</span></span><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    578. 

  578. </pre>
    579. 

  579.        </div>
    580. 

  580.        <div class="interface-member-description">
    581. 

  581.         <p class="para _1">
    582. 

  582.          <code class="fsharp"><span class="ci">expectedStringCIError</span> <span class="ci">str</span></code> creates an <code class="fsharp"><a
    583. 

  583.          href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a
    584. 

  584.          href="#members.ExpectedStringCI"><span class="ci">ExpectedStringCI</span></a> <span class="ci">str</span></code> message.
    585. 

  585.         </p>
    586. 

  586.        </div>
    587. 

  587.       </div>
    588. 

  588.       <div class="interface-member _6" id="members.unexpectedError">
    589. 

  589.        <div class="interface-member-code">
    590. 

  590.         <a class="interface-member-backlink" href="#interface.unexpectedError:B:">⇧</a>
    591. 

  591. <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">unexpectedError</span></span><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    592. 

  592. </pre>
    593. 

  593.        </div>
    594. 

  594.        <div class="interface-member-description">
    595. 

  595.         <p class="para _1">
    596. 

  596.          <code class="fsharp"><span class="ci">unexpectedError</span> <span class="ci">label</span></code> creates an <code class="fsharp"><a
    597. 

  597.          href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a
    598. 

  598.          href="#members.Unexpected"><span class="ci">Unexpected</span></a> <span class="ci">label</span></code> message.
    599. 

  599.         </p>
    600. 

  600.        </div>
    601. 

  601.       </div>
    602. 

  602.       <div class="interface-member _7" id="members.unexpectedStringError">
    603. 

  603.        <div class="interface-member-code">
    604. 

  604.         <a class="interface-member-backlink" href="#interface.unexpectedStringError:B:">⇧</a>
    605. 

  605. <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">unexpectedStringError</span></span><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    606. 

  606. </pre>
    607. 

  607.        </div>
    608. 

  608.        <div class="interface-member-description">
    609. 

  609.         <p class="para _1">
    610. 

  610.          <code class="fsharp"><span class="ci">unexpectedStringError</span> <span class="ci">str</span></code> creates an <code class="fsharp"><a
    611. 

  611.          href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a
    612. 

  612.          href="#members.UnexpectedString"><span class="ci">UnexpectedString</span></a> <span class="ci">str</span></code> message.
    613. 

  613.         </p>
    614. 

  614.        </div>
    615. 

  615.       </div>
    616. 

  616.       <div class="interface-member _8" id="members.unexpectedStringCIError">
    617. 

  617.        <div class="interface-member-code">
    618. 

  618.         <a class="interface-member-backlink" href="#interface.unexpectedStringCIError:B:">⇧</a>
    619. 

  619. <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">unexpectedStringCIError</span></span><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    620. 

  620. </pre>
    621. 

  621.        </div>
    622. 

  622.        <div class="interface-member-description">
    623. 

  623.         <p class="para _1">
    624. 

  624.          <code class="fsharp"><span class="ci">unexpectedStringCIError</span> <span class="ci">str</span></code> creates an <code class="fsharp"><a
    625. 

  625.          href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a
    626. 

  626.          href="#members.UnexpectedStringCI"><span class="ci">UnexpectedStringCI</span></a> <span class="ci">str</span></code> message.
    627. 

  627.         </p>
    628. 

  628.        </div>
    629. 

  629.       </div>
    630. 

  630.       <div class="interface-member _9" id="members.messageError">
    631. 

  631.        <div class="interface-member-code">
    632. 

  632.         <a class="interface-member-backlink" href="#interface.messageError:B:">⇧</a>
    633. 

  633. <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">messageError</span></span><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    634. 

  634. </pre>
    635. 

  635.        </div>
    636. 

  636.        <div class="interface-member-description">
    637. 

  637.         <p class="para _1">
    638. 

  638.          <code class="fsharp"><span class="ci">messageError</span> <span class="ci">msg</span></code> creates an <code class="fsharp"><a
    639. 

  639.          href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a
    640. 

  640.          href="#members.Message"><span class="ci">Message</span></a> <span class="ci">msg</span></code> message.
    641. 

  641.         </p>
    642. 

  642.        </div>
    643. 

  643.       </div>
    644. 

  644.       <div class="interface-member _0" id="members.otherError">
    645. 

  645.        <div class="interface-member-code">
    646. 

  646.         <a class="interface-member-backlink" href="#interface.otherError:B:">⇧</a>
    647. 

  647. <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">otherError</span></span><span class="cp">:</span> <span class="ci">obj</span> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    648. 

  648. </pre>
    649. 

  649.        </div>
    650. 

  650.        <div class="interface-member-description">
    651. 

  651.         <p class="para _1">
    652. 

  652.          <code class="fsharp"><span class="ci">otherError</span> <span class="ci">o</span></code> creates an <code class="fsharp"><a
    653. 

  653.          href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a
    654. 

  654.          href="#members.OtherError"><span class="ci">OtherError</span></a> <span class="ci">o</span></code> message.
    655. 

  655.         </p>
    656. 

  656.        </div>
    657. 

  657.       </div>
    658. 

  658.       <div class="interface-member _1" id="members.compoundError">
    659. 

  659.        <div class="interface-member-code">
    660. 

  660.         <a class="interface-member-backlink" href="#interface.compoundError:B:">⇧</a>
    661. 

  661. <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">compoundError</span></span><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-&gt;</span> <a href="state.html"><span class="ci">State</span></a><span class="cp">&lt;</span><span class="ctv">'u</span><span class="cp">&gt;</span> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    662. 

  662. </pre>
    663. 

  663.        </div>
    664. 

  664.        <div class="interface-member-description">
    665. 

  665.         <p class="para _1">
    666. 

  666.          <code class="fsharp"><span class="ci">compoundError</span> <span class="ci">label</span> <span class="ci">state</span> <span
    667. 

  667.          class="ci">msgs</span></code> creates an <code class="fsharp"><a href="#members.ErrorMessageList"><span
    668. 

  668.          class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a href="#members.CompoundError"><span
    669. 

  669.          class="ci">CompoundError</span></a> <span class="ci">label</span> <span class="ci">state</span><span class="cm">.</span><a
    670. 

  670.          href="#members.Position"><span class="ci">Position</span></a> <span class="ci">msgs</span></code> message, except if <code
    671. 

  671.          class="fsharp"><span class="ci">msgs</span></code> is an <code class="fsharp"><a href="#members.ErrorMessageList"><span
    672. 

  672.          class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a href="#members.BacktrackPoint"><span
    673. 

  673.          class="ci">BacktrackPoint</span></a><span class="cp">(</span><span class="ci">pos2</span><span class="cp">,</span> <span
    674. 

  674.          class="ci">msgs2</span><span class="cp">)</span></code> message, in which case an <code class="fsharp"><a
    675. 

  675.          href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a
    676. 

  676.          href="#members.CompoundError"><span class="ci">CompoundError</span></a> <span class="ci">label</span> <span class="ci">pos2</span> <span
    677. 

  677.          class="ci">msgs2</span></code> message is returned instead.
    678. 

  678.         </p>
    679. 

  679.        </div>
    680. 

  680.       </div>
    681. 

  681.       <div class="interface-member _2" id="members.backtrackError">
    682. 

  682.        <div class="interface-member-code">
    683. 

  683.         <a class="interface-member-backlink" href="#interface.backtrackError:B:">⇧</a>
    684. 

  684. <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">backtrackError</span></span><span class="cp">:</span> <a href="state.html"><span class="ci">State</span></a><span class="cp">&lt;</span><span class="ctv">'u</span><span class="cp">&gt;</span> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    685. 

  685. </pre>
    686. 

  686.        </div>
    687. 

  687.        <div class="interface-member-description">
    688. 

  688.         <p class="para _1">
    689. 

  689.          <code class="fsharp"><span class="ci">backtrackError</span> <span class="ci">state</span> <span class="ci">msgs</span></code> creates an
    690. 

  690.          <code class="fsharp"><a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> with a single <code
    691. 

  691.          class="fsharp"><a href="#members.BacktrackPoint"><span class="ci">BacktrackPoint</span></a> <span class="ci">stat</span><span
    692. 

  692.          class="cm">.</span><a href="#members.Position"><span class="ci">Position</span></a> <span class="ci">msgs</span></code> message, except if
    693. 

  693.          <code class="fsharp"><span class="ci">msgs</span></code> is already an <code class="fsharp"><a href="#members.ErrorMessageList"><span
    694. 

  694.          class="ci">ErrorMessageList</span></a></code> with a single <code class="fsharp"><a href="#members.BacktrackPoint"><span
    695. 

  695.          class="ci">BacktrackPoint</span></a><span class="cp">(</span><span class="ci">_</span><span class="cp">,</span> <span
    696. 

  696.          class="ci">_</span><span class="cp">)</span></code> message, in which case <code class="fsharp"><span class="ci">msgs</span></code> is
    697. 

  697.          returned instead.
    698. 

  698.         </p>
    699. 

  699.        </div>
    700. 

  700.       </div>
    701. 

  701.       <div class="interface-member _3" id="members.concatErrorMessages">
    702. 

  702.        <div class="interface-member-code">
    703. 

  703.         <a class="interface-member-backlink" href="#interface.concatErrorMessages:B:">⇧</a>
    704. 

  704. <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">concatErrorMessages</span></span><span class="cp">:</span>
    705. 

  705.         <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    706. 

  706. </pre>
    707. 

  707.        </div>
    708. 

  708.        <div class="interface-member-description">
    709. 

  709.         <p class="para _1">
    710. 

  710.          <code class="fsharp"><span class="ci">concatErrorMessages</span> <span class="ci">error1</span> <span class="ci">error2</span></code>
    711. 

  711.          concatenates the two error message lists <code class="fsharp"><span class="ci">error1</span></code> and <code class="fsharp"><span
    712. 

  712.          class="ci">error2</span></code>.
    713. 

  713.         </p>
    714. 

  714.        </div>
    715. 

  715.       </div>
    716. 

  716.       <div class="interface-member _4" id="members.mergeErrors">
    717. 

  717.        <div class="interface-member-code">
    718. 

  718.         <a class="interface-member-backlink" href="#interface.mergeErrors:B:">⇧</a>
    719. 

  719. <pre class="code fsharp"><span class="ck">val</span> <span class="ck">inline</span> <span class="interface-member-marker"><span class="ci">mergeErrors</span></span><span class="cp">:</span>
    720. 

  720.         <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    721. 

  721. </pre>
    722. 

  722.        </div>
    723. 

  723.        <div class="interface-member-description">
    724. 

  724.         <p class="para _1">
    725. 

  725.          <code class="fsharp"><span class="ci">mergeErrors</span> <span class="ci">error1</span> <span class="ci">error2</span></code> is an inlined
    726. 

  726.          variant of <code class="fsharp"><a href="#members.concatErrorMessages"><span class="ci">concatErrorMessages</span></a> <span
    727. 

  727.          class="ci">error1</span> <span class="ci">error2</span></code> that avoids the call to <code class="fsharp"><a
    728. 

  728.          href="#members.concatErrorMessages"><span class="ci">concatErrorMessages</span></a></code> if <code class="fsharp"><span
    729. 

  729.          class="ci">error1</span></code> is empty (i.e. equals <code class="fsharp"><a href="#members.NoErrorMessages"><span
    730. 

  730.          class="ci">NoErrorMessages</span></a></code>).
    731. 

  731.         </p>
    732. 

  732.        </div>
    733. 

  733.       </div>
    734. 

  734.       <div class="interface-member _5" id="members.mergeErrorsIfNeeded">
    735. 

  735.        <div class="interface-member-code">
    736. 

  736.         <a class="interface-member-backlink" href="#interface.mergeErrorsIfNeeded:B:">⇧</a>
    737. 

  737. <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">mergeErrorsIfNeeded</span></span><span class="cp">:</span>
    738. 

  738.         <span class="ci">oldState</span><span class="cp">:</span> <a href="state.html"><span class="ci">State</span></a><span class="cp">&lt;</span><span class="ctv">'u</span><span class="cp">&gt;</span> <span class="cr">-&gt;</span> <span class="ci">oldError</span><span class="cp">:</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    739. 

  739.      <span class="cr">-&gt;</span> <span class="ci">newState</span><span class="cp">:</span> <a href="state.html"><span class="ci">State</span></a><span class="cp">&lt;</span><span class="ctv">'u</span><span class="cp">&gt;</span> <span class="cr">-&gt;</span> <span class="ci">newError</span><span class="cp">:</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    740. 

  740.      <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    741. 

  741. </pre>
    742. 

  742.        </div>
    743. 

  743.        <div class="interface-member-description">
    744. 

  744.         <div class="para _1">
    745. 

  745.          <p>
    746. 

  746.           <code class="fsharp"><span class="ci">mergeErrorsIfNeeded</span> <span class="ci">oldState</span> <span class="ci">oldError</span> <span
    747. 

  747.           class="ci">newState</span> <span class="ci">newError</span></code> is equivalent to
    748. 

  748.          </p>
    749. 

  749. <pre class="code fsharp"><span class="ck">if</span> <span class="ci">newState</span> <span class="co">&lt;&gt;</span> <a href="state.html"><span class="ci">State</span></a> <span class="ck">then</span> <span class="ci">newError</span> <span class="ck">else</span> <a href="#members.mergeErrors"><span class="ci">mergeErrors</span></a> <span class="ci">oldError</span> <span class="ci">newError</span></pre>
    750. 

  750.         </div>
    751. 

  751.        </div>
    752. 

  752.       </div>
    753. 

  753.       <div class="interface-member _6" id="members.mergeErrorsIfNeeded3">
    754. 

  754.        <div class="interface-member-code">
    755. 

  755.         <a class="interface-member-backlink" href="#interface.mergeErrorsIfNeeded3:B:">⇧</a>
    756. 

  756. <pre class="code fsharp"><span class="ck">val</span> <span class="interface-member-marker"><span class="ci">mergeErrorsIfNeeded3</span></span><span class="cp">:</span>
    757. 

  757.         <span class="ci">oldestState</span><span class="cp">:</span> <a href="state.html"><span class="ci">State</span></a><span class="cp">&lt;</span><span class="ctv">'u</span><span class="cp">&gt;</span> <span class="cr">-&gt;</span> <span class="ci">oldestError</span><span class="cp">:</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    758. 

  758.      <span class="cr">-&gt;</span> <span class="ci">oldState</span><span class="cp">:</span>    <a href="state.html"><span class="ci">State</span></a><span class="cp">&lt;</span><span class="ctv">'u</span><span class="cp">&gt;</span> <span class="cr">-&gt;</span> <span class="ci">oldError</span><span class="cp">:</span>    <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    759. 

  759.      <span class="cr">-&gt;</span> <span class="ci">newState</span><span class="cp">:</span>    <a href="state.html"><span class="ci">State</span></a><span class="cp">&lt;</span><span class="ctv">'u</span><span class="cp">&gt;</span> <span class="cr">-&gt;</span> <span class="ci">newError</span><span class="cp">:</span>    <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    760. 

  760.      <span class="cr">-&gt;</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    761. 

  761. </pre>
    762. 

  762.        </div>
    763. 

  763.        <div class="interface-member-description">
    764. 

  764.         <div class="para _1">
    765. 

  765.          <p>
    766. 

  766.           <code class="fsharp"><span class="ci">mergeErrorsIfNeeded3</span> <span class="ci">veryOldState</span> <span
    767. 

  767.           class="ci">veryOldError</span> <span class="ci">oldState</span> <span class="ci">oldError</span> <span class="ci">newState</span> <span
    768. 

  768.           class="ci">newError</span></code> is equivalent to
    769. 

  769.          </p>
    770. 

  770. <pre class="code fsharp"><a href="#members.mergeErrorsIfNeeded"><span class="ci">mergeErrorsIfNeeded</span></a>
    771. 

  771.        <span class="ci">oldState</span> <span class="cp">(</span><a href="#members.mergeErrorsIfNeeded"><span class="ci">mergeErrorsIfNeeded</span></a> <span class="ci">veryOldState</span> <span class="ci">veryOldError</span>
    772. 

  772.                                          <span class="ci">oldState</span>     <span class="ci">oldError</span><span class="cp">)</span>
    773. 

  773.        <span class="ci">newState</span> <span class="ci">newError</span>
    774. 

  774.   </pre>
    775. 

  775.         </div>
    776. 

  776.        </div>
    777. 

  777.       </div>
    778. 

  778.       <div class="interface-member _7" id="members.ParserError">
    779. 

  779.        <div class="interface-member-code">
    780. 

  780.         <a class="interface-member-backlink" href="#interface.ParserError:B:">⇧</a>
    781. 

  781. <pre class="code fsharp"><span class="cp">[&lt;</span><span class="ci">Sealed</span><span class="cp">&gt;]</span>
    782. 

  782. <span class="ck">type</span> <span class="interface-member-marker"><span class="ci">ParserError</span></span></pre>
    783. 

  783.        </div>
    784. 

  784.        <div class="interface-member-description">
    785. 

  785.         <p class="para _1">
    786. 

  786.          <code class="fsharp"><span class="ci">ParserError</span></code> is a simple container type for holding an <code class="fsharp"><a
    787. 

  787.          href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> together with its associated input stream position.
    788. 

  788.         </p>
    789. 

  789.         <div class="para _2">
    790. 

  790.          <div class="interface-members">
    791. 

  791.           <div class="interface-member _1" id="members.new">
    792. 

  792.            <div class="interface-member-code">
    793. 

  793.             <a class="interface-member-backlink" href="#interface.new:B:">⇧</a>
    794. 

  794. <pre class="code fsharp"><span class="interface-member-marker"><span class="ck">new</span></span><span class="cp">:</span> <a href="position.html"><span class="ci">Position</span></a> <span class="cp">*</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a> <span class="cr">-&gt;</span> <span class="ci">ParserError</span>
    795. 

  795. </pre>
    796. 

  796.            </div>
    797. 

  797.            <div class="interface-member-description">
    798. 

  798.             <p class="para _1">
    799. 

  799.              Constructs a <code class="fsharp"><span class="ci">ParserError</span></code> from an <code class="fsharp"><a
    800. 

  800.              href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a></code> and its associated position.
    801. 

  801.             </p>
    802. 

  802.            </div>
    803. 

  803.           </div>
    804. 

  804.           <div class="interface-member _2" id="members.Position">
    805. 

  805.            <div class="interface-member-code">
    806. 

  806.             <a class="interface-member-backlink" href="#interface.Position:B:">⇧</a>
    807. 

  807. <pre class="code fsharp"><span class="ck">member</span> <span class="interface-member-marker"><span class="ci">Position</span></span><span class="cp">:</span> <a href="position.html"><span class="ci">Position</span></a>
    808. 

  808. </pre>
    809. 

  809.            </div>
    810. 

  810.            <div class="interface-member-description">
    811. 

  811.             <p class="para _1">The input stream position of the parser error.</p>
    812. 

  812.            </div>
    813. 

  813.           </div>
    814. 

  814.           <div class="interface-member _3" id="members.member-ErrorMessageList">
    815. 

  815.            <div class="interface-member-code">
    816. 

  816.             <a class="interface-member-backlink" href="#interface.member-ErrorMessageList:B:">⇧</a>
    817. 

  817. <pre class="code fsharp"><span class="ck">member</span> <span class="interface-member-marker"><span class="ci">ErrorMessageList</span></span><span class="cp">:</span> <a href="#members.ErrorMessageList"><span class="ci">ErrorMessageList</span></a>
    818. 

  818. </pre>
    819. 

  819.            </div>
    820. 

  820.            <div class="interface-member-description">
    821. 

  821.             <p class="para _1">The error messages of the parser error.</p>
    822. 

  822.            </div>
    823. 

  823.           </div>
    824. 

  824.           <div class="interface-member _4" id="members.ToString">
    825. 

  825.            <div class="interface-member-code">
    826. 

  826.             <a class="interface-member-backlink" href="#interface.ToString:B:">⇧</a>
    827. 

  827. <pre class="code fsharp"><span class="ck">override</span> <span class="interface-member-marker"><span class="ci">ToString</span></span><span class="cp">:</span> <span class="ci">unit</span> <span class="cr">-&gt;</span> <span class="ci">string</span>
    828. 

  828. </pre>
    829. 

  829.            </div>
    830. 

  830.            <div class="interface-member-description">
    831. 

  831.             <div class="para _1">
    832. 

  832.              <p>Is equivalent to</p>
    833. 

  833. <pre class="code fsharp"><span class="ck">use</span> <span class="ci">sw</span> <span class="cp">=</span> <span class="ck">new</span> <a href="http://msdn.microsoft.com/en-us/library/system.io.stringwriter.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">StringWriter</span></a><span class="cp">()</span>
    834. 

  834. <a href="#members.WriteTo"><span class="ci">WriteTo</span></a><span class="cp">(</span><span class="ci">sw</span><span class="cp">)</span>
    835. 

  835. <span class="ci">sw</span><span class="cm">.</span><span class="ci">ToString</span><span class="cp">()</span>
    836. 

  836. </pre>
    837. 

  837.             </div>
    838. 

  838.            </div>
    839. 

  839.           </div>
    840. 

  840.           <div class="interface-member _5" id="members.ToString_CharStream">
    841. 

  841.            <div class="interface-member-code">
    842. 

  842.             <a class="interface-member-backlink" href="#interface.ToString_CharStream:B:">⇧</a>
    843. 

  843. <pre class="code fsharp"><span class="ck">member</span> <span class="interface-member-marker"><span class="ci">ToString</span></span><span class="cp">:</span> <span class="ci">streamWhereErrorOccurred</span><span class="cp">:</span> <a href="charstream.html"><span class="ci">CharStream</span></a> <span class="cr">-&gt;</span> <span class="ci">string</span>
    844. 

  844. </pre>
    845. 

  845.            </div>
    846. 

  846.            <div class="interface-member-description">
    847. 

  847.             <div class="para _1">
    848. 

  848.              <p>Is equivalent to</p>
    849. 

  849. <pre class="code fsharp"><span class="ck">use</span> <span class="ci">sw</span> <span class="cp">=</span> <span class="ck">new</span> <a href="http://msdn.microsoft.com/en-us/library/system.io.stringwriter.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">StringWriter</span></a><span class="cp">()</span>
    850. 

  850. <a href="#members.WriteTo_stream"><span class="ci">WriteTo</span></a><span class="cp">(</span><span class="ci">sw</span><span class="cp">,</span> <span class="ci">streamWhereErrorOccurred</span><span class="cp">)</span>
    851. 

  851. <span class="ci">sw</span><span class="cm">.</span><span class="ci">ToString</span><span class="cp">()</span>
    852. 

  852. </pre>
    853. 

  853.             </div>
    854. 

  854.            </div>
    855. 

  855.           </div>
    856. 

  856.           <div class="interface-member _6" id="members.WriteTo_stream">
    857. 

  857.            <div class="interface-member-code">
    858. 

  858.             <a class="interface-member-backlink" href="#interface.WriteTo_stream:B:">⇧</a>
    859. 

  859. <pre class="code fsharp"><span class="ck">member</span> <span class="interface-member-marker"><span class="ci">WriteTo</span></span><span class="cp">:</span>
    860. 

  860.          <span class="ci">textWriter</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">TextWriter</span></a>
    861. 

  861.        <span class="cp">*</span> <span class="ci">streamWhereErrorOccurred</span><span class="cp">:</span> <a href="charstream.html"><span class="ci">CharStream</span></a>
    862. 

  862.        <span class="cp">*</span> <span class="cp">?</span><span class="ci">columnWidth</span><span class="cp">:</span> <span class="ci">int</span>
    863. 

  863.        <span class="cp">*</span> <span class="cp">?</span><span class="ci">initialIndentation</span><span class="cp">:</span> <span class="ci">string</span> <span class="cp">*</span> <span class="cp">?</span><span class="ci">indentationIncrement</span><span class="cp">:</span> <span class="ci">string</span>
    864. 

  864.        <span class="cr">-&gt;</span> <span class="ci">unit</span>
    865. 

  865. </pre>
    866. 

  866.            </div>
    867. 

  867.            <div class="interface-member-description">
    868. 

  868.             <div class="para _1">
    869. 

  869.              <p>Is equivalent to</p>
    870. 

  870. <pre class="code fsharp"><span class="ck">let</span> <span class="ci">getStreamByName</span> <span class="ci">streamName</span> <span class="cp">=</span>
    871. 

  871.     <span class="ck">if</span> <span class="ci">streamName</span> <span class="co">=</span> <a href="#members.Position"><span class="ci">Position</span></a><span class="cm">.</span><span class="ci">StreamName</span> <span class="ck">then</span> <span class="ci">streamWhereErrorOccurred</span> <span class="ck">else</span> <span class="cnu">null</span>
    872. 

  872. 

  873. <a href="#members.WriteTo_getStreamByName"><span class="ci">WriteTo</span></a><span class="cp">(</span><span class="ci">textWriter</span><span class="cp">,</span> <span class="ci">getStreamByName</span><span class="cp">,</span>
    874. 

  874.         <span class="cp">?</span><span class="ci">columWidth</span> <span class="co">=</span> <span class="ci">columnWidth</span><span class="cp">,</span>
    875. 

  875.         <span class="cp">?</span><span class="ci">initialIndentation</span> <span class="co">=</span> <span class="ci">initialIndentation</span><span class="cp">,</span>
    876. 

  876.         <span class="cp">?</span><span class="ci">indentationIncrement</span> <span class="co">=</span> <span class="ci">indentationIncrement</span><span class="cp">)</span>
    877. 

  877. </pre>
    878. 

  878.             </div>
    879. 

  879.            </div>
    880. 

  880.           </div>
    881. 

  881.           <div class="interface-member _7" id="members.WriteTo_getStreamByName">
    882. 

  882.            <div class="interface-member-code">
    883. 

  883.             <a class="interface-member-backlink" href="#interface.WriteTo_getStreamByName:B:">⇧</a>
    884. 

  884. <pre class="code fsharp"><span class="ck">member</span> <span class="interface-member-marker"><span class="ci">WriteTo</span></span><span class="cp">:</span>
    885. 

  885.          <span class="ci">textWriter</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">TextWriter</span></a>
    886. 

  886.        <span class="cp">*</span> <span class="ci">getStreamByName</span><span class="cp">:</span> <span class="cp">(</span><span class="ci">string</span> <span class="cr">-&gt;</span> <a href="charstream.html"><span class="ci">CharStream</span></a><span class="cp">)</span>
    887. 

  887.        <span class="cp">*</span> <span class="cp">?</span><span class="ci">columnWidth</span><span class="cp">:</span> <span class="ci">int</span>
    888. 

  888.        <span class="cp">*</span> <span class="cp">?</span><span class="ci">initialIndentation</span><span class="cp">:</span> <span class="ci">string</span> <span class="cp">*</span> <span class="cp">?</span><span class="ci">indentationIncrement</span><span class="cp">:</span> <span class="ci">string</span>
    889. 

  889.        <span class="cr">-&gt;</span> <span class="ci">unit</span>
    890. 

  890. </pre>
    891. 

  891.            </div>
    892. 

  892.            <div class="interface-member-description">
    893. 

  893.             <p class="para _1">
    894. 

  894.              Writes a string representation of the <code class="fsharp"><span class="ci">ParserError</span></code> to the given <code
    895. 

  895.              class="fsharp"><a href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">TextWriter</span></a></code>
    896. 

  896.              value.
    897. 

  897.             </p>
    898. 

  898.             <p class="para _2">
    899. 

  899.              For each error position <code class="fsharp"><span class="ci">getStreamByName</span></code> is called with the <code class="fsharp"><span
    900. 

  900.              class="ci">StreamName</span></code> of the <code class="fsharp"><a href="position.html"><span class="ci">Position</span></a></code>. The
    901. 

  901.              returned <code class="fsharp"><a href="charstream.html"><span class="ci">CharStream</span></a></code> must be <code class="fsharp"><span
    902. 

  902.              class="cnu">null</span></code> or contain the content of the <code class="fsharp"><a href="charstream.html"><span
    903. 

  903.              class="ci">CharStream</span></a></code> for which the error was generated (at the original indices).
    904. 

  904.             </p>
    905. 

  905.             <p class="para _3">
    906. 

  906.              If <code class="fsharp"><span class="ci">getStreamByName</span></code> returns a non‐null <code class="fsharp"><a
    907. 

  907.              href="charstream.html"><span class="ci">CharStream</span></a></code>, the printed error position information is augmented with the line
    908. 

  908.              of text surrounding the error position, together with a &#x2018;^&#x2019;‐marker pointing to the exact location of the error in the input
    909. 

  909.              stream.
    910. 

  910.             </p>
    911. 

  911.            </div>
    912. 

  912.           </div>
    913. 

  913.           <div class="interface-member _8" id="members.WriteTo">
    914. 

  914.            <div class="interface-member-code">
    915. 

  915.             <a class="interface-member-backlink" href="#interface.WriteTo:B:">⇧</a>
    916. 

  916. <pre class="code fsharp"><span class="ck">member</span> <span class="interface-member-marker"><span class="ci">WriteTo</span></span><span class="cp">:</span>
    917. 

  917.          <span class="ci">textWriter</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">TextWriter</span></a>
    918. 

  918.        <span class="cp">*</span> <span class="cp">?</span><span class="ci">positionPrinter</span><span class="cp">:</span>
    919. 

  919.            <span class="cp">(</span><a href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">TextWriter</span></a> <span class="cr">-&gt;</span> <a href="position.html"><span class="ci">Position</span></a> <span class="cr">-&gt;</span> <span class="ci">string</span> <span class="cr">-&gt;</span> <span class="ci">int</span> <span class="cr">-&gt;</span> <span class="ci">unit</span><span class="cp">)</span>
    920. 

  920.        <span class="cp">*</span> <span class="cp">?</span><span class="ci">columnWidth</span><span class="cp">:</span> <span class="ci">int</span>
    921. 

  921.        <span class="cp">*</span> <span class="cp">?</span><span class="ci">initialIndentation</span><span class="cp">:</span> <span class="ci">string</span> <span class="cp">*</span> <span class="cp">?</span><span class="ci">indentationIncrement</span><span class="cp">:</span> <span class="ci">string</span>
    922. 

  922.        <span class="cr">-&gt;</span> <span class="ci">unit</span>
    923. 

  923. </pre>
    924. 

  924.            </div>
    925. 

  925.            <div class="interface-member-description">
    926. 

  926.             <p class="para _1">
    927. 

  927.              Writes a string representation of the <code class="fsharp"><span class="ci">ParserError</span></code> to the given <code
    928. 

  928.              class="fsharp"><a href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">TextWriter</span></a></code>
    929. 

  929.              value.
    930. 

  930.             </p>
    931. 

  931.             <p class="para _2">
    932. 

  932.              The format of the position information can be customized by specifying the <code class="fsharp"><span
    933. 

  933.              class="ci">positionPrinter</span></code> argument. The given function is expected to print a representation of the passed <code
    934. 

  934.              class="fsharp"><a href="position.html"><span class="ci">Position</span></a></code> value to the passed <code class="fsharp"><a
    935. 

  935.              href="http://msdn.microsoft.com/en-us/library/system.io.textwriter.aspx"><span class="ci">TextWriter</span></a></code> value. If
    936. 

  936.              possible, it should indent text lines with the passed string and take into account the maximum column count (including indentation)
    937. 

  937.              passed as the last argument.
    938. 

  938.             </p>
    939. 

  939.            </div>
    940. 

  940.           </div>
    941. 

  941.          </div>
    942. 

  942.         </div>
    943. 

  943.        </div>
    944. 

  944.       </div>
    945. 

  945.      </div>
    946. 

  946.     </div>
    947. 

  947.    </div>
    948. 

  948.   </div>
    949. 

  949.  </div>
    950. 

  950.  </div>
    951. 

  951.  </div>   
    952. 

  952.  </div>
    953. 

  953. </body>
    954. 

  954. </html>
    955. 

  955. 

  956.