/fparsec/main/Doc/html/reference/charstream.html

http://github.com/sandersn/fing · HTML · 1839 lines · 1804 code · 29 blank · 6 comment · 0 complexity · 0eb8354014409e44363fac4b55d0b5f9 MD5 · raw file

Large files are truncated click here to view the full 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.CharStream</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.              <tr class="nav-entry n3 _5">
    68. 

  68.               <td class="nav-number n3"><a href="error.html"><span class="section-number">5</span><span class="nav-space"></span></a></td>
    69. 

  69.               <td class="nav-title n3"><a href="error.html">FParsec.Error</a></td>
    70. 

  70.              </tr>
    71. 

  71.              <tr class="nav-entry n3 _6">
    72. 

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

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

  74.              </tr>
    75. 

  75.              <tr class="nav-entry n3 _7">
    76. 

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

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

  78.              </tr>
    79. 

  79.             </tbody>
    80. 

  80.             <tbody class="nav-open selected n3">
    81. 

  81.              <tr class="nav-entry selected n3 _8">
    82. 

  82.               <td class="nav-number selected n3"><a href="#"><span class="section-number">8</span><span class="nav-space"></span></a></td>
    83. 

  83.               <td class="nav-title selected n3"><a href="#">FParsec.CharStream</a></td>
    84. 

  84.              </tr>
    85. 

  85.              <tr class="nav-sub-entries selected n3 _8">
    86. 

  86.               <td class="nav-sub-entries-number selected n3"></td>
    87. 

  87.               <td class="nav-sub-entries selected n3">
    88. 

  88.                <table class="nav n4">
    89. 

  89.                 <tbody class="nav-before-open n4">
    90. 

  90.                  <tr class="nav-entry n4 _1">
    91. 

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

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

  93.                  </tr>
    94. 

  94.                  <tr class="nav-entry n4 _2">
    95. 

  95.                   <td class="nav-number n4"><a href="#remarks"><span class="section-number">2</span><span class="nav-space"></span></a></td>
    96. 

  96.                   <td class="nav-title n4"><a href="#remarks">Remarks</a></td>
    97. 

  97.                  </tr>
    98. 

  98.                  <tr class="nav-entry n4 _3">
    99. 

  99.                   <td class="nav-number n4"><a href="#exceptions"><span class="section-number">3</span><span class="nav-space"></span></a></td>
    100. 

  100.                   <td class="nav-title n4"><a href="#exceptions">I/O exceptions</a></td>
    101. 

  101.                  </tr>
    102. 

  102.                  <tr class="nav-entry n4 _4">
    103. 

  103.                   <td class="nav-number n4"><a href="#members"><span class="section-number">4</span><span class="nav-space"></span></a></td>
    104. 

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

  105.                  </tr>
    106. 

  106.                  <tr class="nav-entry n4 _5">
    107. 

  107.                   <td class="nav-number n4"><a href="#Iterator"><span class="section-number">5</span><span class="nav-space"></span></a></td>
    108. 

  108.                   <td class="nav-title n4"><a href="#Iterator">CharStream.Iterator</a></td>
    109. 

  109.                  </tr>
    110. 

  110.                  <tr class="nav-sub-entries n4 _5">
    111. 

  111.                   <td class="nav-sub-entries-number n4"></td>
    112. 

  112.                   <td class="nav-sub-entries n4">
    113. 

  113.                    <table class="nav n5">
    114. 

  114.                     <tbody class="nav-before-open n5">
    115. 

  115.                      <tr class="nav-entry n5 _1">
    116. 

  116.                       <td class="nav-number n5">
    117. 

  117.                        <a href="#Iterator.interface"><span class="section-number">1</span><span class="nav-space"></span></a>
    118. 

  118.                       </td>
    119. 

  119.                       <td class="nav-title n5"><a href="#Iterator.interface">Interface</a></td>
    120. 

  120.                      </tr>
    121. 

  121.                      <tr class="nav-entry n5 _2">
    122. 

  122.                       <td class="nav-number n5">
    123. 

  123.                        <a href="#Iterator.members"><span class="section-number">2</span><span class="nav-space"></span></a>
    124. 

  124.                       </td>
    125. 

  125.                       <td class="nav-title n5"><a href="#Iterator.members">Members</a></td>
    126. 

  126.                      </tr>
    127. 

  127.                     </tbody>
    128. 

  128.                    </table>
    129. 

  129.                   </td>
    130. 

  130.                  </tr>
    131. 

  131.                 </tbody>
    132. 

  132.                </table>
    133. 

  133.               </td>
    134. 

  134.              </tr>
    135. 

  135.             </tbody>
    136. 

  136.            </table>
    137. 

  137.           </td>
    138. 

  138.          </tr>
    139. 

  139.         </tbody>
    140. 

  140.        </table>
    141. 

  141.       </td>
    142. 

  142.      </tr>
    143. 

  143.     </tbody>
    144. 

  144.    </table>
    145. 

  145.   </div>
    146. 

  146.  </div>
    147. 

  147.  </div>
    148. 

  148.  </div>
    149. 

  149.  <div id="wrapper">   
    150. 

  150.  <div id="main">
    151. 

  151.  <div id="main-content"> 
    152. 

  152.  <div id="breadcrumbs">
    153. 

  153.   <span class="breadcrumbs">
    154. 

  154.    <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.CharStream
    155. 

  155.   </span>
    156. 

  156.  </div>  
    157. 

  157.  <div class="section s2">
    158. 

  158.   <h1 class="title h2"><span class="section-number">2.8</span> FParsec.CharStream</h1>
    159. 

  159.   <div class="intro i2">
    160. 

  160.    <p class="para _1">
    161. 

  161.     The <code class="fsharp"><span class="ci">CharStream</span></code> class provides a unified interface for reading the UTF‐16 char content from
    162. 

  162.     binary streams or in‐memory char buffers.
    163. 

  163.    </p>
    164. 

  164.   </div>
    165. 

  165.   <div id="interface" class="section s3">
    166. 

  166.    <h2 class="title h3"><span class="section-number">2.8.1</span> Interface</h2>
    167. 

  167.    <div class="intro i3">
    168. 

  168.     <div class="para _1">
    169. 

  169. <pre class="code fsharp"><span class="ck">namespace</span> <span class="ci">FParsec</span>
    170. 

  170. 

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

  172. <span class="ck">type</span> <span class="ci">CharStream</span> <span class="cp">=</span>
    173. 

  173.   <span class="ck">interface</span> <span class="ci">System</span><span class="cm">.</span><span class="ci">IDisposable</span>
    174. 

  174. 

  175.   <a id="interface.new_string:B:" href="#members.new_string"><span class="interface-member-marker"><span class="ck">new</span></span></a><span class="cp">:</span>    <span class="ci">chars</span><span class="cp">:</span> <span class="ci">string</span> <span class="cp">*</span> <span class="ci">index</span><span class="cp">:</span> <span class="ci">int</span> <span class="cp">*</span> <span class="ci">length</span><span class="cp">:</span> <span class="ci">int</span>
    176. 

  176.        <span class="cr">-&gt;</span> <span class="ci">CharStream</span>
    177. 

  177.   <a id="interface.new_string_offset:B:" href="#members.new_string_offset"><span class="interface-member-marker"><span class="ck">new</span></span></a><span class="cp">:</span>    <span class="ci">chars</span><span class="cp">:</span> <span class="ci">string</span> <span class="cp">*</span> <span class="ci">index</span><span class="cp">:</span> <span class="ci">int</span> <span class="cp">*</span> <span class="ci">length</span><span class="cp">:</span> <span class="ci">int</span> <span class="cp">*</span> <span class="ci">streamBeginIndex</span><span class="cp">:</span> <span class="ci">int64</span>
    178. 

  178.        <span class="cr">-&gt;</span> <span class="ci">CharStream</span>
    179. 

  179. 

  180.   <a id="interface.new_char-array:B:" href="#members.new_char-array"><span class="interface-member-marker"><span class="ck">new</span></span></a><span class="cp">:</span>    <span class="ci">chars</span><span class="cp">:</span> <span class="ci">char</span><span class="cp">[]</span> <span class="cp">*</span> <span class="ci">index</span><span class="cp">:</span> <span class="ci">int</span> <span class="cp">*</span> <span class="ci">length</span><span class="cp">:</span> <span class="ci">int</span>
    181. 

  181.        <span class="cr">-&gt;</span> <span class="ci">CharStream</span>
    182. 

  182.   <a id="interface.new_char-array_offset:B:" href="#members.new_char-array_offset"><span class="interface-member-marker"><span class="ck">new</span></span></a><span class="cp">:</span>    <span class="ci">chars</span><span class="cp">:</span> <span class="ci">char</span><span class="cp">[]</span> <span class="cp">*</span> <span class="ci">index</span><span class="cp">:</span> <span class="ci">int</span> <span class="cp">*</span> <span class="ci">length</span><span class="cp">:</span> <span class="ci">int</span> <span class="cp">*</span> <span class="ci">streamBeginIndex</span><span class="cp">:</span> <span class="ci">int64</span>
    183. 

  183.        <span class="cr">-&gt;</span> <span class="ci">CharStream</span>
    184. 

  184. 

  185.   <a id="interface.new_char-pointer:B:" href="#members.new_char-pointer"><span class="interface-member-marker"><span class="ck">new</span></span></a><span class="cp">:</span>    <span class="ci">chars</span><span class="cp">:</span> <span class="ci">NativePtr</span><span class="cp">&lt;</span><span class="ci">char</span><span class="cp">&gt;</span> <span class="cp">*</span> <span class="ci">length</span><span class="cp">:</span> <span class="ci">int</span>
    186. 

  186.        <span class="cr">-&gt;</span> <span class="ci">CharStream</span>
    187. 

  187.   <a id="interface.new_char-pointer_offset:B:" href="#members.new_char-pointer_offset"><span class="interface-member-marker"><span class="ck">new</span></span></a><span class="cp">:</span>    <span class="ci">chars</span><span class="cp">:</span> <span class="ci">NativePtr</span><span class="cp">&lt;</span><span class="ci">char</span><span class="cp">&gt;</span> <span class="cp">*</span> <span class="ci">length</span><span class="cp">:</span> <span class="ci">int</span> <span class="cp">*</span> <span class="ci">streamBeginIndex</span><span class="cp">:</span> <span class="ci">int64</span>
    188. 

  188.        <span class="cr">-&gt;</span> <span class="ci">CharStream</span>
    189. 

  189. 

  190.   <a id="interface.new_file-path:B:" href="#members.new_file-path"><span class="interface-member-marker"><span class="ck">new</span></span></a><span class="cp">:</span>    <span class="ci">path</span><span class="cp">:</span> <span class="ci">string</span> <span class="cp">*</span> <span class="ci">encoding</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">Text</span><span class="cm">.</span><span class="ci">Encoding</span></a>
    191. 

  191.        <span class="cr">-&gt;</span> <span class="ci">CharStream</span>
    192. 

  192.   <a id="interface.new_file-path_2:B:" href="#members.new_file-path_2"><span class="interface-member-marker"><span class="ck">new</span></span></a><span class="cp">:</span>    <span class="ci">path</span><span class="cp">:</span> <span class="ci">string</span>
    193. 

  193.         <span class="cp">*</span> <span class="ci">encoding</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">Text</span><span class="cm">.</span><span class="ci">Encoding</span></a> <span class="cp">*</span> <span class="ci">detectEncodingFromByteOrderMarks</span><span class="cp">:</span> <span class="ci">bool</span>
    194. 

  194.        <span class="cr">-&gt;</span> <span class="ci">CharStream</span>
    195. 

  195.   <a id="interface.new_file-path_3:B:" href="#members.new_file-path_3"><span class="interface-member-marker"><span class="ck">new</span></span></a><span class="cp">:</span>    <span class="ci">path</span><span class="cp">:</span> <span class="ci">string</span>
    196. 

  196.         <span class="cp">*</span> <span class="ci">encoding</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">Text</span><span class="cm">.</span><span class="ci">Encoding</span></a> <span class="cp">*</span> <span class="ci">detectEncodingFromByteOrderMarks</span><span class="cp">:</span> <span class="ci">bool</span>
    197. 

  197.         <span class="cp">*</span> <span class="ci">blockSize</span><span class="cp">:</span> <span class="ci">int</span> <span class="cp">*</span> <span class="ci">blockOverlap</span><span class="cp">:</span> <span class="ci">int</span> <span class="cp">*</span> <span class="ci">minRegexSpace</span><span class="cp">:</span> <span class="ci">int</span>
    198. 

  198.         <span class="cp">*</span> <span class="ci">byteBufferLength</span><span class="cp">:</span> <span class="ci">int</span>
    199. 

  199.        <span class="cr">-&gt;</span> <span class="ci">CharStream</span>
    200. 

  200. 

  201.   <a id="interface.new_stream:B:" href="#members.new_stream"><span class="interface-member-marker"><span class="ck">new</span></span></a><span class="cp">:</span>    <span class="ci">stream</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.io.stream.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">Stream</span></a> <span class="cp">*</span> <span class="ci">encoding</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">Text</span><span class="cm">.</span><span class="ci">Encoding</span></a>
    202. 

  202.        <span class="cr">-&gt;</span> <span class="ci">CharStream</span>
    203. 

  203.   <a id="interface.new_stream_2:B:" href="#members.new_stream_2"><span class="interface-member-marker"><span class="ck">new</span></span></a><span class="cp">:</span>    <span class="ci">stream</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.io.stream.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">Stream</span></a> <span class="cp">*</span> <span class="ci">leaveOpen</span><span class="cp">:</span> <span class="ci">bool</span>
    204. 

  204.         <span class="cp">*</span> <span class="ci">encoding</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">Text</span><span class="cm">.</span><span class="ci">Encoding</span></a>
    205. 

  205.        <span class="cr">-&gt;</span> <span class="ci">CharStream</span>
    206. 

  206.   <a id="interface.new_stream_3:B:" href="#members.new_stream_3"><span class="interface-member-marker"><span class="ck">new</span></span></a><span class="cp">:</span>    <span class="ci">stream</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.io.stream.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">Stream</span></a> <span class="cp">*</span> <span class="ci">leaveOpen</span><span class="cp">:</span> <span class="ci">bool</span>
    207. 

  207.         <span class="cp">*</span> <span class="ci">encoding</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">Text</span><span class="cm">.</span><span class="ci">Encoding</span></a> <span class="cp">*</span> <span class="ci">detectEncodingFromByteOrderMarks</span><span class="cp">:</span> <span class="ci">bool</span>
    208. 

  208.        <span class="cr">-&gt;</span> <span class="ci">CharStream</span>
    209. 

  209.   <a id="interface.new_stream_4:B:" href="#members.new_stream_4"><span class="interface-member-marker"><span class="ck">new</span></span></a><span class="cp">:</span>    <span class="ci">stream</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.io.stream.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">Stream</span></a> <span class="cp">*</span> <span class="ci">leaveOpen</span><span class="cp">:</span> <span class="ci">bool</span>
    210. 

  210.         <span class="cp">*</span> <span class="ci">encoding</span><span class="cp">:</span> <a href="http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx"><span class="ci">System</span><span class="cm">.</span><span class="ci">Text</span><span class="cm">.</span><span class="ci">Encoding</span></a> <span class="cp">*</span> <span class="ci">detectEncodingFromByteOrderMarks</span><span class="cp">:</span> <span class="ci">bool</span>
    211. 

  211.         <span class="cp">*</span> <span class="ci">blockSize</span><span class="cp">:</span> <span class="ci">int</span> <span class="cp">*</span> <span class="ci">blockOverlap</span><span class="cp">:</span> <span class="ci">int</span> <span class="cp">*</span> <span class="ci">minRegexSpace</span><span class="cp">:</span> <span class="ci">int</span>
    212. 

  212.         <span class="cp">*</span> <span class="ci">byteBufferLength</span><span class="cp">:</span> <span class="ci">int</span>
    213. 

  213.        <span class="cr">-&gt;</span> <span class="ci">CharStream</span>
    214. 

  214. 

  215.   <span class="ck">member</span> <a id="interface.Dispose:B:" href="#members.Dispose"><span class="interface-member-marker"><span class="ci">Dispose</span></span></a><span class="cp">:</span> <span class="ci">unit</span> <span class="cr">-&gt;</span> <span class="ci">unit</span>
    216. 

  216. 

  217.   <span class="ck">member</span> <a id="interface.Begin:B:" href="#members.Begin"><span class="interface-member-marker"><span class="ci">Begin</span></span></a><span class="cp">:</span> <a href="#Iterator"><span class="ci">Iterator</span></a>
    218. 

  218.   <span class="ck">member</span> <a id="interface.Seek:B:" href="#members.Seek"><span class="interface-member-marker"><span class="ci">Seek</span></span></a><span class="cp">:</span> <span class="ci">int64</span> <span class="cr">-&gt;</span> <a href="#Iterator"><span class="ci">Iterator</span></a>
    219. 

  219. 

  220.   <span class="ck">member</span> <a id="interface.BeginIndex:B:" href="#members.BeginIndex"><span class="interface-member-marker"><span class="ci">BeginIndex</span></span></a><span class="cp">:</span> <span class="ci">int64</span>
    221. 

  221.   <span class="ck">member</span> <a id="interface.EndIndex:B:" href="#members.EndIndex"><span class="interface-member-marker"><span class="ci">EndIndex</span></span></a><span class="cp">:</span> <span class="ci">int64</span>
    222. 

  222. 

  223.   <span class="ck">static</span> <span class="ck">member</span> <a id="interface.FoldCase:B:" href="#members.FoldCase"><span class="interface-member-marker"><span class="ci">FoldCase</span></span></a><span class="cp">:</span>          <span class="ci">string</span> <span class="cr">-&gt;</span> <span class="ci">string</span>
    224. 

  224.   <span class="ck">static</span> <span class="ck">member</span> <a id="interface.NormalizeNewlines:B:" href="#members.NormalizeNewlines"><span class="interface-member-marker"><span class="ci">NormalizeNewlines</span></span></a><span class="cp">:</span> <span class="ci">string</span> <span class="cr">-&gt;</span> <span class="ci">string</span>
    225. 

  225. 

  226.   <span class="cp">[&lt;</span><span class="ci">Struct</span><span class="cp">&gt;]</span>
    227. 

  227.   <span class="ck">type</span> <span class="bold"><a href="#Iterator"><span class="ci">Iterator</span></a></span> <span class="cp">=</span> <span class="cbc"><span class="left-delimiter">(*</span> see below <span class="right-delimiter">*)</span></span>
    228. 

  228. 

  229. </pre>
    230. 

  230.     </div>
    231. 

  231.    </div>
    232. 

  232.   </div>
    233. 

  233.   <div id="remarks" class="section s3">
    234. 

  234.    <h2 class="title h3"><span class="section-number">2.8.2</span> Remarks</h2>
    235. 

  235.    <div class="intro i3">
    236. 

  236.     <p class="para _1">
    237. 

  237.      The <code class="fsharp"><span class="ci">CharStream</span></code> class provides an <a
    238. 

  238.      href="http://en.wikipedia.org/wiki/Iterator">iterator‐based</a> interface for reading UTF‐16 chars from a binary stream or an in‐memory char
    239. 

  239.      buffer (e.g. a string). It is optimized for use in backtracking parser applications and supports arbitrary <em>char‐based</em> seeking, even for
    240. 

  240.      streams larger than physical memory.
    241. 

  241.     </p>
    242. 

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

  243.      A <code class="fsharp"><span class="ci">CharStream</span></code> constructed from a <code class="fsharp"><a
    244. 

  244.      href="http://msdn.microsoft.com/en-us/library/system.io.stream.aspx"><span class="ci">System</span><span class="cm">.</span><span
    245. 

  245.      class="ci">IO</span><span class="cm">.</span><span class="ci">Stream</span></a></code> or a file path reads the stream block‐wise and only holds
    246. 

  246.      the most recently accessed block in memory. The blocks overlap in order to provide efficient access on the boundary between blocks.
    247. 

  247.     </p>
    248. 

  248.     <p class="para _3">
    249. 

  249.      If the char content is already available as a string or a char array, a <code class="fsharp"><span class="ci">CharStream</span></code> can be
    250. 

  250.      directly constructed from the char buffer (without needing to copy the buffer). The overhead of accessing an in‐memory char buffer through a
    251. 

  251.      <code class="fsharp"><span class="ci">CharStream</span></code> is minimal.
    252. 

  252.     </p>
    253. 

  253.     <p class="para _4">
    254. 

  254.      You can access the content of a <code class="fsharp"><span class="ci">CharStream</span></code> only through its <code class="fsharp"><a
    255. 

  255.      href="#Iterator"><span class="ci">Iterator</span></a></code> instances. The <code class="fsharp"><a href="#members.Begin"><span
    256. 

  256.      class="ci">Begin</span></a></code> property returns an iterator pointing to the first char in the stream. The <code class="fsharp"><a
    257. 

  257.      href="#members.Seek"><span class="ci">Seek</span></a></code> method returns an iterator pointing to the char with a given index.
    258. 

  258.     </p>
    259. 

  259.     <div class="para _5">
    260. 

  260.      <div class="dl multi-para">
    261. 

  261.       <dl class="dl multi-para">
    262. 

  262.        <dt class="_1"><a id="remarks.low-trust-version"></a>Low‐Trust version</dt>
    263. 

  263.        <dd class="_1">
    264. 

  264.         <div class="para _1">
    265. 

  265.          <p>
    266. 

  266.           If you compile FParsec with the <code class="fsharp"><span class="ci">LOW_TRUST</span></code> conditional compiler symbol, the <code
    267. 

  267.           class="fsharp"><span class="ci">CharStream</span></code> class differs from the normal version as follows:
    268. 

  268.          </p>
    269. 

  269.          <ul class="l1">
    270. 

  270.           <li class="_1">
    271. 

  271.            No <a href="http://msdn.microsoft.com/en-us/library/t2yzs44b.aspx">unverifiable code</a> involving pointers is used. <em>This allows
    272. 

  272.            FParsec to be executed in an environment with reduced trust</em>, such as medium trust ASP.NET applications.
    273. 

  273.           </li>
    274. 

  274.           <li class="_2">
    275. 

  275.            A <code class="fsharp"><span class="ci">CharStream</span></code> that is constructed from a <code class="fsharp"><a
    276. 

  276.            href="http://msdn.microsoft.com/en-us/library/system.io.stream.aspx"><span class="ci">System</span><span class="cm">.</span><span
    277. 

  277.            class="ci">IO</span><span class="cm">.</span><span class="ci">Stream</span></a></code> or a file path reads the complete file into a single
    278. 

  278.            string during construction. <em>This severely limits the maximum practical stream size.</em>
    279. 

  279.           </li>
    280. 

  280.           <li class="_3">
    281. 

  281.            Although the <code class="fsharp"><span class="ci">CharStream</span></code> class still supports the <code class="fsharp"><span
    282. 

  282.            class="ci">IDisposable</span></code> interface, disposing the <code class="fsharp"><span class="ci">CharStream</span></code> instances is
    283. 

  283.            no longer necessary, since no resources are hold that need to be explicitly released.
    284. 

  284.           </li>
    285. 

  285.          </ul>
    286. 

  286.         </div>
    287. 

  287.        </dd>
    288. 

  288.        <dt class="_2"><a id="remarks.non-sequential-access"></a>Non‐sequential access</dt>
    289. 

  289.        <dd class="_2">
    290. 

  290.         <p class="para _1">
    291. 

  291.          <span class="small"><span class="italic">This note does not apply to the <a href="#remarks.low-trust-version">Low‐Trust version</a> of
    292. 

  292.          FParsec.</span></span><br /> If you construct a <code class="fsharp"><span class="ci">CharStream</span></code> from a <code class="fsharp"><a
    293. 

  293.          href="http://msdn.microsoft.com/en-us/library/system.io.stream.aspx"><span class="ci">System</span><span class="cm">.</span><span
    294. 

  294.          class="ci">IO</span><span class="cm">.</span><span class="ci">Stream</span></a></code> or a file path and you backtrack over a distance long
    295. 

  295.          enough to require the <code class="fsharp"><span class="ci">CharStream</span></code> to reread a previous block, then the underlying
    296. 

  296.          <strong>byte stream needs to support seeking</strong>, otherwise a <code class="fsharp"><a
    297. 

  297.          href="http://msdn.microsoft.com/en-us/library/system.notsupportedexception.aspx"><span class="ci">NotSupportedException</span></a></code> is
    298. 

  298.          thrown. Furthermore, the <strong><a href="http://msdn.microsoft.com/en-us/library/system.text.decoder.aspx">Decoder</a> for the input <a
    299. 

  299.          href="http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx">Encoding</a> must be serializable</strong> if you backtrack to a
    300. 

  300.          block other than the first in the stream. Note that <em>file streams created for regular disk files are always seekable and all the .NET
    301. 

  301.          standard decoders are serializable</em>. In order to support non‐seekable streams for applications which don’t require extensive
    302. 

  302.          backtracking, no exception will be thrown before an operation actually requires backtracking and the necessary capabilities of the stream or
    303. 

  303.          decoder are not available.
    304. 

  304.         </p>
    305. 

  305.        </dd>
    306. 

  306.        <dt class="_3">Decoder errors</dt>
    307. 

  307.        <dd class="_3">
    308. 

  308.         <p class="para _1">
    309. 

  309.          A <code class="fsharp"><span class="ci">CharStream</span></code> constructed from a binary input stream decodes the input data with the help
    310. 

  310.          of a <code class="fsharp"><a href="http://msdn.microsoft.com/en-us/library/system.text.decoder.aspx"><span
    311. 

  311.          class="ci">Decoder</span></a></code> instance obtained via the <code class="fsharp"><span class="ci">Encodings</span></code>’s <code
    312. 

  312.          class="fsharp"><span class="ci">GetDecoder</span></code> method. Depending on the configuration of the encoding the decoder might throw an
    313. 

  313.          exception if it encounters invalid byte sequences, usually a <code class="fsharp"><span class="ci">System</span><span
    314. 

  314.          class="cm">.</span><span class="ci">Text</span><span class="cm">.</span><a
    315. 

  315.          href="http://msdn.microsoft.com/en-us/library/system.text.decoderfallbackexception.aspx"><span
    316. 

  316.          class="ci">DecoderFallbackException</span></a></code> or a <code class="fsharp"><span class="ci">System</span><span class="cm">.</span><span
    317. 

  317.          class="ci">IO</span><span class="cm">.</span><a href="http://msdn.microsoft.com/en-us/library/system.argumentexception.aspx"><span
    318. 

  318.          class="ci">ArgumentException</span></a></code>. <sup class="fn-mark"><a id="remarks.:FN:1:B:" href="#remarks.:FN:1">[1]</a></sup>
    319. 

  319.         </p>
    320. 

  320.        </dd>
    321. 

  321.        <dt class="_4"><a id="remarks.case-insensitive-matching"></a>Case‐insensitive matching</dt>
    322. 

  322.        <dd class="_4">
    323. 

  323.         <p class="para _1">
    324. 

  324.          The <code class="fsharp"><a href="#Iterator.members.MatchCaseFolded"><span class="ci">MatchCaseFolded</span></a></code> member matches the
    325. 

  325.          content of the stream &#x201C;case‐insensitively&#x201D; with a reference string. In this instance &#x201C;case‐insensitive&#x201D; means
    326. 

  326.          that before the chars are matched with the reference string they are <a
    327. 

  327.          href="http://unicode.org/reports/tr21/tr21-5.html#Caseless_Matching">mapped to a canonical form where case differences are erased</a>. For
    328. 

  328.          performance reasons <code class="fsharp"><a href="#Iterator.members.MatchCaseFolded"><span class="ci">MatchCaseFolded</span></a></code> only
    329. 

  329.          applies the (non‐Turkic) 1‐to‐1 <a href="http://unicode.org/Public/UNIDATA/CaseFolding.txt">case folding mappings</a> (v. 5.1) for Unicode
    330. 

  330.          code points in the Basic Multilingual Plane, i.e. code points below 0x10000. These mappings are sufficient for many case‐insensitive parser
    331. 

  331.          grammars encountered in practice, but they are not appropriate for matching arbitrary natural language content. Also note that the <code
    332. 

  332.          class="fsharp"><span class="ci">CharStream</span></code> class performs no Unicode <a
    333. 

  333.          href="http://unicode.org/reports/tr15/">normalization</a>.
    334. 

  334.         </p>
    335. 

  335.        </dd>
    336. 

  336.        <dt class="_5">Newlines</dt>
    337. 

  337.        <dd class="_5">
    338. 

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

  339.          The <code class="fsharp"><span class="ci">CharStream</span></code> class itself does not apply any automatic newline conversion to the
    340. 

  340.          processed input. A useful helper function for this purpose is <code class="fsharp"><a href="#members.NormalizeNewlines"><span
    341. 

  341.          class="ci">NormalizeNewlines</span></a></code>, which replaces all ASCII newline character sequences (<code class="fsharp"><span
    342. 

  342.          class="cs"><span class="left-delimiter">"</span><span class="ce">\n</span><span class="right-delimiter">"</span></span></code>, <code
    343. 

  343.          class="fsharp"><span class="cs"><span class="left-delimiter">"</span><span class="ce">\r</span><span class="ce">\n</span><span
    344. 

  344.          class="right-delimiter">"</span></span></code> or <code class="fsharp"><span class="cs"><span class="left-delimiter">"</span><span
    345. 

  345.          class="ce">\r</span><span class="right-delimiter">"</span></span></code>) in a given string with <code class="fsharp"><span class="cs"><span
    346. 

  346.          class="left-delimiter">"</span><span class="ce">\n</span><span class="right-delimiter">"</span></span></code>.
    347. 

  347.         </p>
    348. 

  348.        </dd>
    349. 

  349.        <dt class="_6">Disposable interface</dt>
    350. 

  350.        <dd class="_6">
    351. 

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

  352.          <span class="small"><span class="italic">This note does not apply to the <a href="#remarks.low-trust-version">Low‐Trust version</a> of
    353. 

  353.          FParsec.</span></span><br /> A <code class="fsharp"><span class="ci">CharStream</span></code> holds managed and unmanaged resources that need
    354. 

  354.          to be explicitly released. Hence, it is very important that <code class="fsharp"><span class="ci">CharStream</span></code> objects are
    355. 

  355.          promptly disposed after use. Where possible <code class="fsharp"><span class="ci">CharStream</span></code> objects should only be used within
    356. 

  356.          a &#x201C;using&#x201D; block (C#), a &#x201C;use&#x201D; expression( F#) or similar constructs in other languages. Members of <code
    357. 

  357.          class="fsharp"><a href="#Iterator"><span class="ci">CharStream</span><span class="cm">.</span><span class="ci">Iterator</span></a></code>
    358. 

  358.          instances must not be accessed after the corresponding <code class="fsharp"><span class="ci">CharStream</span></code> has been disposed, of
    359. 

  359.          course.
    360. 

  360.         </p>
    361. 

  361.        </dd>
    362. 

  362.        <dt class="_7">Thread safety</dt>
    363. 

  363.        <dd class="_7">
    364. 

  364.         <p class="para _1">
    365. 

  365.          A <code class="fsharp"><span class="ci">CharStream</span></code> constructed from a <code class="fsharp"><a
    366. 

  366.          href="http://msdn.microsoft.com/en-us/library/system.io.stream.aspx"><span class="ci">System</span><span class="cm">.</span><span
    367. 

  367.          class="ci">IO</span><span class="cm">.</span><span class="ci">Stream</span></a></code> or a file path is not thread safe and its members may
    368. 

  368.          not be accessed by multiple threads, except in the <a href="#remarks.low-trust-version">Low‐Trust version</a> of FParsec. A <code
    369. 

  369.          class="fsharp"><span class="ci">CharStream</span></code> constructed directly from a string, char array or char pointer can always be safely
    370. 

  370.          accessed concurrently using different <code class="fsharp"><span class="ci">Iterators</span></code> (provided that the <code
    371. 

  371.          class="fsharp"><span class="ci">CharStream</span></code> is disposed by only one thread, of course). <span class="italic"><code
    372. 

  372.          class="fsharp"><a href="#Iterator"><span class="ci">CharStream</span><span class="cm">.</span><span class="ci">Iterator</span></a></code>
    373. 

  373.          instances are never thread safe.</span>
    374. 

  374.         </p>
    375. 

  375.        </dd>
    376. 

  376.       </dl>
    377. 

  377.      </div>
    378. 

  378.     </div>
    379. 

  379.    </div>
    380. 

  380.   </div>
    381. 

  381.   <div id="exceptions" class="section s3">
    382. 

  382.    <h2 class="title h3"><span class="section-number">2.8.3</span> I/O exceptions</h2>
    383. 

  383.    <div class="intro i3">
    384. 

  384.     <p class="para _1">
    385. 

  385.      If you construct a <code class="fsharp"><span class="ci">CharStream</span></code> from a <code class="fsharp"><a
    386. 

  386.      href="http://msdn.microsoft.com/en-us/library/system.io.stream.aspx"><span class="ci">System</span><span class="cm">.</span><span
    387. 

  387.      class="ci">IO</span><span class="cm">.</span><span class="ci">Stream</span></a></code> or a file path, any <code class="fsharp"><span
    388. 

  388.      class="ci">CharStream</span></code> operation that requires reading chars from the underlying byte stream may throw one of the following
    389. 

  389.      exceptions.
    390. 

  390.     </p>
    391. 

  391.     <p class="para _2">
    392. 

  392.      In general it is <em>not</em> safe to continue to use a <code class="fsharp"><span class="ci">CharStream</span></code> instance after one of
    393. 

  393.      these exceptions was thrown. Calling <code class="fsharp"><a href="#members.Dispose"><span class="ci">Dispose</span></a><span
    394. 

  394.      class="cp">()</span></code> on an <code class="fsharp"><span class="ci">CharStream</span></code> instance after the instance or one of its
    395. 

  395.      iterators has thrown an exception is always safe.
    396. 

  396.     </p>
    397. 

  397.     <div class="para _3">
    398. 

  398.      <div class="dl multi-para">
    399. 

  399.       <dl class="dl multi-para">
    400. 

  400.        <dt class="_1"><code class="fsharp"><span class="ci">NotSupportedException</span></code></dt>
    401. 

  401.        <dd class="_1">
    402. 

  402.         <p class="para _1">
    403. 

  403.          Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the <code class="fsharp"><a
    404. 

  404.          href="http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx"><span class="ci">Encoding</span></a></code>’s <code
    405. 

  405.          class="fsharp"><a href="http://msdn.microsoft.com/en-us/library/system.text.decoder.aspx"><span class="ci">Decoder</span></a></code> is not
    406. 

  406.          serializable. See also the remarks above on <a href="#remarks.non-sequential-access">non‐sequential access</a>.
    407. 

  407.         </p>
    408. 

  408.        </dd>
    409. 

  409.        <dt class="_2"><code class="fsharp"><span class="ci">IOException</span></code></dt>
    410. 

  410.        <dd class="_2">
    411. 

  411.         <p class="para _1">An I/O occured while reading data from the underlying byte stream.</p>
    412. 

  412.        </dd>
    413. 

  413.        <dt class="_3"><code class="fsharp"><span class="ci">ArgumentException</span></code></dt>
    414. 

  414.        <dd class="_3">
    415. 

  415.         <p class="para _1">
    416. 

  416.          The underlying byte stream contains invalid bytes and the <code class="fsharp"><a
    417. 

  417.          href="http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx"><span class="ci">Encoding</span></a></code> was constructed with the
    418. 

  418.          <code class="fsharp"><span class="ci">throwOnInvalidBytes</span></code> option.
    419. 

  419.         </p>
    420. 

  420.        </dd>
    421. 

  421.        <dt class="_4"><code class="fsharp"><span class="ci">DecoderFallbackException</span></code></dt>
    422. 

  422.        <dd class="_4">
    423. 

  423.         <p class="para _1">The underlying byte stream contains invalid bytes for which the decoder fallback threw this exception.</p>
    424. 

  424.         <p class="para _2">
    425. 

  425.          The byte index of the invalid bytes in the stream is stored as a boxed <code class="fsharp"><span class="ci">System</span><span
    426. 

  426.          class="cm">.</span><span class="ci">Int64</span></code> in the <code class="fsharp"><span class="cs"><span
    427. 

  427.          class="left-delimiter">"</span>Stream.Position<span class="right-delimiter">"</span></span></code> entry of the <code class="fsharp"><a
    428. 

  428.          href="http://msdn.microsoft.com/en-us/library/system.exception.data.aspx"><span class="ci">Data</span></a></code> member of the exception
    429. 

  429.          instance. The precision of the index depends on the precision of the <code class="fsharp"><a
    430. 

  430.          href="http://msdn.microsoft.com/en-us/library/system.text.decoderfallbackexception.aspx"><span
    431. 

  431.          class="ci">DecoderFallbackException</span></a></code>’s <code class="fsharp"><a
    432. 

  432.          href="http://msdn.microsoft.com/en-us/library/system.text.decoderfallbackexception.index.aspx"><span class="ci">Index</span></a></code>
    433. 

  433.          member. If the underlying <code class="fsharp"><a href="http://msdn.microsoft.com/en-us/library/system.io.stream.aspx"><span
    434. 

  434.          class="ci">System</span><span class="cm">.</span><span class="ci">IO</span><span class="cm">.</span><span class="ci">Stream</span></a></code>
    435. 

  435.          is not seekable, the byte index only takes into account the bytes read by the <code class="fsharp"><span class="ci">CharStream</span></code>,
    436. 

  436.          but not any bytes read before the <code class="fsharp"><span class="ci">CharStream</span></code> was constructed.
    437. 

  437.         </p>
    438. 

  438.        </dd>
    439. 

  439.       </dl>
    440. 

  440.      </div>
    441. 

  441.     </div>
    442. 

  442.    </div>
    443. 

  443.   </div>
    444. 

  444.   <div id="members" class="section s3">
    445. 

  445.    <h2 class="title h3"><span class="section-number">2.8.4</span> Members</h2>
    446. 

  446.    <div class="intro i3">
    447. 

  447.     <div class="para _1">
    448. 

  448.      <div class="interface-members">
    449. 

  449.       <div class="interface-member _1" id="members.new_string">
    450. 

  450.        <div class="interface-member-code">
    451. 

  451.         <a class="interface-member-backlink" href="#interface.new_string:B:">⇧</a>
    452. 

  452. <pre class="code fsharp"><span class="interface-member-marker"><span class="ck">new</span></span><span class="cp">:</span>    <span class="ci">chars</span><span class="cp">:</span> <span class="ci">string</span> <span class="cp">*</span> <span class="ci">index</span><span class="cp">:</span> <span class="ci">int</span> <span class="cp">*</span> <span class="ci">length</span><span class="cp">:</span> <span class="ci">int</span>
    453. 

  453.      <span class="cr">-&gt;</span> <span class="ci">CharStream</span>
    454. 

  454. </pre>
    455. 

  455.        </div>
    456. 

  456.        <div class="interface-member-description">
    457. 

  457.         <p class="para _1">
    458. 

  458.          Is equivalent to <code class="fsharp"><a href="#members.new_string_offset"><span class="ck">new</span> <span
    459. 

  459.          class="ci">CharStream</span></a><span class="cp">(</span><span class="ci">chars</span><span class="cp">,</span> <span
    460. 

  460.          class="ci">index</span><span class="cp">,</span> <span class="ci">length</span><span class="cp">,</span> <span class="cn">0L</span><span
    461. 

  461.          class="cp">)</span></code>.
    462. 

  462.         </p>
    463. 

  463.        </div>
    464. 

  464.       </div>
    465. 

  465.       <div class="interface-member _2" id="members.new_string_offset">
    466. 

  466.        <div class="interface-member-code">
    467. 

  467.         <a class="interface-member-backlink" href="#interface.new_string_offset:B:">⇧</a>
    468. 

  468. <pre class="code fsharp"><span class="interface-member-marker"><span class="ck">new</span></span><span class="cp">:</span>    <span class="ci">chars</span><span class="cp">:</span> <span class="ci">string</span> <span class="cp">*</span> <span class="ci">index</span><span class="cp">:</span> <span class="ci">int</span> <span class="cp">*</span> <span class="ci">length</span><span class="cp">:</span> <span class="ci">int</span> <span class="cp">*</span> <span class="ci">streamBeginIndex</span><span class="cp">:</span> <span class="ci">int64</span>
    469. 

  469.      <span class="cr">-&gt;</span> <span class="ci">CharStream</span>
    470. 

  470. </pre>
    471. 

  471.        </div>
    472. 

  472.        <div class="interface-member-description">
    473. 

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

  474.          Constructs a <code class="fsharp"><span class="ci">CharStream</span></code> from the chars in the string argument between the indices <code
    475. 

  475.          class="fsharp"><span class="ci">index</span></code> (inclusive) and <code class="fsharp"><span class="ci">index</span> <span
    476. 

  476.          class="co">+</span> <span class="ci">length</span></code> (exclusive). By directly referencing the chars in the string this constructor
    477. 

  477.          avoids any copy of the string content.
    478. 

  478.         </p>
    479. 

  479.         <p class="para _2">
    480. 

  480.          The first char in the stream is assigned the index <code class="fsharp"><span class="ci">streamBeginIndex</span></code>. A positive <code
    481. 

  481.          class="fsharp"><span class="ci">streamBeginIndex</span></code> allows you for example to create a substream of another <code
    482. 

  482.          class="fsharp"><span class="ci">CharStream</span></code>, i.e. a <code class="fsharp"><span class="ci">CharStream</span></code> instance that
    483. 

  483.          only contains a sub‐segment of another char stream but is accessible through the same char indices.
    484. 

  484.         </p>
    485. 

  485.         <div class="para _3">
    486. 

  486.          <p>
    487. 

  487.           <code class="fsharp"><span class="ci">chars</span></code> must not be null. An <code class="fsharp"><a
    488. 

  488.           href="http://msdn.microsoft.com/en-us/library/system.argumentoutofrangeexception.aspx"><span
    489. 

  489.           class="ci">ArgumentOutOfRangeException</span></a></code> is thrown if the arguments do not satisfy the following conditions:
    490. 

  490.          </p>
    491. 

  491.          <ul class="l1">
    492. 

  492.           <li class="_1">
    493. 

  493.            <code class="fsharp"><span class="ci">index</span></code> ≥ 0, <code class="fsharp"><span class="ci">length</span></code> ≥ 0, <code
    494. 

  494.            class="fsharp"><span class="ci">index</span></code> + <code class="fsharp"><span class="ci">length</span></code> ≤ <code
    495. 

  495.            class="fsharp"><span class="ci">chars</span><span class="cm">.</span><span class="ci">Length</span></code> and
    496. 

  496.           </li>
    497. 

  497.           <li class="_2">0 ≤ <code class="fsharp"><span class="ci">streamBeginIndex</span></code> &lt; 2<sup>60</sup>.</li>
    498. 

  498.          </ul>
    499. 

  499.         </div>
    500. 

  500.         <div class="para _4">
    501. 

  501.          <div class="admonition">
    502. 

  502.           <div class="admonition-title">Important</div>
    503. 

  503.           <div class="admonition-body">
    504. 

  504.            <p class="para _1">
    505. 

  505.             <span class="small"><span class="italic">This note does not apply to the <a href="#remarks.low-trust-version">Low‐Trust version</a> of
    506. 

  506.             FParsec.</span></span><br /> The given string is &#x201C;<a
    507. 

  507.             href="http://msdn.microsoft.com/en-us/library/83y4ak54.aspx">pinned</a>&#x201D; until the <code class="fsharp"><span
    508. 

  508.             class="ci">CharStream</span></code> is disposed. Pinning the string prevents the GC from moving it around in memory during garbage
    509. 

  509.             collection. On .NET (at least in versions up to and including 4.0) the pinning has no effect if the string is large enough to be allocated
    510. 

  510.             on the Large Object Heap, i.e. has a length of about 42500 chars or more. However, pinning smaller strings does constrain the normal
    511. 

  511.             operations of the GC. Thus, <strong>to minimize the negative impact on the GC, you should dispose <code class="fsharp"><span
    512. 

  512.             class="ci">CharStream</span></code> instances constructed from small strings as soon as you’re done parsing it</strong>. If you keep a
    513. 

  513.             large number of <code class="fsharp"><span class="ci">CharStream</span></code> instances constructed from small strings around for an
    514. 

  514.             extended period of time, you risk fragmenting the heap.
    515. 

  515.            </p>
    516. 

  516.           </div>
    517. 

  517.          </div>
    518. 

  518.         </div>
    519. 

  519.        </div>
    520. 

  520.       </div>
    521. 

  521.       <div class="interface-member _3" id="members.new_char-array">
    522. 

  522.        <div class="interface-member-code">
    523. 

  523.         <a class="interface-member-backlink" href="#interface.new_char-array:B:">⇧</a>
    524. 

  524. <pre class="code fsharp"><span class="interface-member-marker"><span class="ck">new</span></span><span class="cp">:</span>    <span class="ci">chars</span><span class="cp">:</span> <span class="ci">char</span><span class="cp">[]</span> <span class="cp">*</span> <span class="ci">index</span><span class="cp">:</span> <span class="ci">int</span> <span class="cp">*</span> <span class="ci">length</span><span class="cp">:</span> <span class="ci">int</span>
    525. 

  525.      <span class="cr">-&gt;</span> <span class="ci">CharStream</span>
    526. 

  526. </pre>
    527. 

  527.        </div>
    528. 

  528.        <div class="interface-member-description">
    529. 

  529.         <p class="para _1">
    530. 

  530.          <span class="small"><span class="italic">This constructor is not available in the <a href="#remarks.low-trust-version">Low‐Trust version</a>
    531. 

  531.          of FParsec.</span></span>
    532. 

  532.         </p>
    533. 

  533.         <p class="para _2">
    534. 

  534.          Is equivalent to <code class="fsharp"><a href="#members.new_char-array_offset"><span class="ck">new</span> <span
    535. 

  535.          class="ci">CharStream</span></a><span class="cp">(</span><span class="ci">chars</span><span class="cp">,</span> <span
    536. 

  536.          class="ci">index</span><span class="cp">,</span> <span class="ci">length</span><span class="cp">,</span> <span class="cn">0L</span><span
    537. 

  537.          class="cp">)</span></code>.
    538. 

  538.         </p>
    539. 

  539.        </div>
    540. 

  540.       </div>
    541. 

  541.       <div class="interface-member _4" id="members.new_char-array_offset">
    542. 

  542.        <div class="interface-member-code">
    543. 

  543.         <a class="interface-member-backlink" href="#interface.new_char-array_offset:B:">⇧</a>
    544. 

  544. <pre class="code fsharp"><span class="interface-member-marker"><span class="ck">new</span></span><span class="cp">:</span>    <span class="ci">chars</span><span class="cp">:</span> <span class="ci">char</span><span class="cp">[]</span> <span class="cp">*</span> <span class="ci">index</span><span class="cp">:</span> <span class="ci">int</span> <span class="cp">*</span> <span class="ci">length</span><span class="cp">:</span> <span class="ci">int</span> <span class="cp">*</span> <span class="ci">streamBeginIndex</span><span class="cp">:</span> <span class="ci">int64</span>
    545. 

  545.      <span class="cr">-&gt;</span> <span class="ci">CharStream</span>
    546. 

  546. </pre>
    547. 

  547.        </div>
    548. 

  548.        <div class="interface-member-description">
    549. 

  549.         <p class="para _1">
    550. 

  550.          <span class="small"><span class="italic">This constructor is not available in the <a href="#remarks.low-trust-version">Low‐Trust version</a>
    551. 

  551.          of FParsec.</span></span>
    552. 

  552.         </p>
    553. 

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

  554.          Constructs a <code class="fsharp"><span class="ci">CharStream</span></code> from the chars in the char array argument between the indices
    555. 

  555.          <code class="fsharp"><span class="ci">index</span></code> (inclusive) and <code class="fsharp"><span class="ci">index</span> <span
    556. 

  556.          class="co">+</span> <span class="ci">length</span></code> (exclusive). By directly referencing the chars in the char array this constructor
    557. 

  557.          avoids any copy of the char array content.
    558. 

  558.         </p>
    559. 

  559.         <p class="para _3">
    560. 

  560.          The first char in the stream is assigned the index <code class="fsharp"><span class="ci">streamBeginIndex</span></code>. A positive <code
    561. 

  561.          class="fsharp"><span class="ci">streamBeginIndex</span></code> allows you for example to create a substream of another <code
    562. 

  562.          class="fsharp"><span class="ci">CharStream</span></code>, i.e. a <code class="fsharp"><span class="ci">CharStream</span></code> instance that
    563. 

  563.          only contains a sub‐segment of another char stream but is accessible through the same char indices.
    564. 

  564.         </p>
    565. 

  565.         <div class="para _4">
    566. 

  566.          <p>
    567. 

  567.           <code class="fsharp"><span class="ci">chars</span></code> must not be null. An <code class="fsharp"><a
    568. 

  568.           href="http://msdn.microsoft.com/en-us/library/system.argumentoutofrangeexception.aspx"><span
    569. 

  569.           class="ci">ArgumentOutOfRangeException</span></a></code> is thrown if the arguments do not satisfy the following conditions:
    570. 

  570.          </p>
    571. 

  571.          <ul class="l1">
    572. 

  572.           <li class="_1">…
    573.