PageRenderTime 53ms CodeModel.GetById 15ms RepoModel.GetById 0ms app.codeStats 0ms

/fparsec/main/Build/VS9/bin/Debug/FParsecCS.XML

http://github.com/sandersn/fing
XML | 525 lines | 525 code | 0 blank | 0 comment | 0 complexity | b464827a22a9e8c9a49ea698222a3694 MD5 | raw file
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>FParsecCS</name>
  5. </assembly>
  6. <members>
  7. <member name="P:FParsec.State`1.LineBegin">
  8. <summary>The stream index of the first char in the line, i.e. Index - Column + 1.</summary>
  9. </member>
  10. <member name="P:FParsec.State`1.Column">
  11. <summary>The 1-based index of the UTF16 char in the line, i.e. Index - LineBegin + 1.</summary>
  12. </member>
  13. <member name="T:FParsec.StringBuffer">
  14. <summary>A substring of a pinned string on the large object heap.
  15. StringBuffers are cached in a pool and hence need to be properly disposed.</summary>
  16. </member>
  17. <member name="F:FParsec.StringBuffer.Allocated">
  18. <summary>Sum of the lengths of all currently allocated StringBuffers</summary>
  19. </member>
  20. <member name="F:FParsec.StringBuffer.PoolSegment.Last">
  21. <summary>the last allocated segment</summary>
  22. </member>
  23. <member name="P:FParsec.StringBuffer.PoolSegment.Size">
  24. <summary>String.Length - x, where x > 0</summary>
  25. </member>
  26. <member name="T:FParsec.CharStream">
  27. <summary>Provides access to the char content of a binary Stream (or a String) through
  28. an iterator-based interface that is especially well suited for parser applications.</summary>
  29. </member>
  30. <member name="F:FParsec.CharStream.BufferString">
  31. <summary>The string holding the char buffer, or null if the buffer is not part of a .NET string.</summary>
  32. </member>
  33. <member name="F:FParsec.CharStream.BufferStringPointer">
  34. <summary>A pointer to the beginning of BufferString, or null if BufferString is null.</summary>
  35. </member>
  36. <member name="F:FParsec.CharStream.BufferHandle">
  37. <summary>Holds the GCHandle for CharStreams directly constructed from strings or char arrays.</summary>
  38. </member>
  39. <member name="F:FParsec.CharStream.Buffer">
  40. <summary>Holds the StringBuffer for CharStreams constructed from a binary stream.</summary>
  41. </member>
  42. <member name="M:FParsec.CharStream.ReadAllRemainingCharsFromStream(System.Char*,System.Int32,System.Byte[],System.Int32,System.Int32,System.IO.Stream,System.Int64,System.Text.Decoder)">
  43. <summary>Reads all remaining chars into the given buffer. If the remaining stream
  44. content holds more than the given maximum number of chars, an exception will be thrown.</summary>
  45. </member>
  46. <member name="M:FParsec.CharStream.#ctor(System.String,System.Int32,System.Int32)">
  47. <summary>Constructs a CharStream from the chars in the string argument between the indices index (inclusive) and index + length (exclusive).</summary>
  48. <exception cref="T:System.ArgumentNullException">chars is null.</exception>
  49. <exception cref="T:System.ArgumentOutOfRangeException">At least one of the following conditions is not satisfied: index 0, length 0 and index + length chars.Length.</exception>
  50. </member>
  51. <member name="M:FParsec.CharStream.#ctor(System.String,System.Int32,System.Int32,System.Int64)">
  52. <summary>Constructs a CharStream from the chars in the string argument between the indices index (inclusive) and index + length (exclusive). The first char in the stream is assigned the index streamBeginIndex.</summary>
  53. <exception cref="T:System.ArgumentNullException">chars is null.</exception>
  54. <exception cref="T:System.ArgumentOutOfRangeException">At least one of the following conditions is not satisfied: index 0, length 0, index + length chars.Length and 0 streamBeginIndex &lt; 2^60.</exception>
  55. </member>
  56. <member name="M:FParsec.CharStream.#ctor(System.Char[],System.Int32,System.Int32)">
  57. <summary>Constructs a CharStream from the chars in the char array argument between the indices index (inclusive) and index + length (exclusive).</summary>
  58. <exception cref="T:System.ArgumentNullException">chars is null.</exception>
  59. <exception cref="T:System.ArgumentOutOfRangeException">At least one of the following conditions is not satisfied: index 0, length 0 and index + length chars.Length.</exception>
  60. </member>
  61. <member name="M:FParsec.CharStream.#ctor(System.Char[],System.Int32,System.Int32,System.Int64)">
  62. <summary>Constructs a CharStream from the chars in the char array argument between the indices index (inclusive) and index + length (exclusive). The first char in the stream is assigned the index streamBeginIndex.</summary>
  63. <exception cref="T:System.NullReferenceException">chars is null.</exception>
  64. <exception cref="T:System.ArgumentOutOfRangeException">At least one of the following conditions is not satisfied: index 0, length 0, index + length chars.Length and 0 streamBeginIndex &lt; 2^60.</exception>
  65. </member>
  66. <member name="M:FParsec.CharStream.#ctor(System.Char*,System.Int32)">
  67. <summary>Constructs a CharStream from the length chars at the pointer address.</summary>
  68. <exception cref="T:System.ArgumentNullException">chars is null.</exception>
  69. <exception cref="T:System.ArgumentOutOfRangeException">length is negative.</exception>
  70. </member>
  71. <member name="M:FParsec.CharStream.#ctor(System.Char*,System.Int32,System.Int64)">
  72. <summary>Constructs a CharStream from the length chars at the pointer address. The first char in the stream is assigned the index streamBeginIndex.</summary>
  73. <exception cref="T:System.ArgumentNullException">chars is null.</exception>
  74. <exception cref="T:System.ArgumentOutOfRangeException">At least one of the following conditions is not satisfied: length 0 and 0 streamBeginIndex &lt; 2^60.</exception>
  75. </member>
  76. <member name="M:FParsec.CharStream.#ctor(System.String,System.Text.Encoding)">
  77. <summary>Constructs a CharStream from the file at the given path.<br/>Is equivalent to CharStream(new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.Read, 4096, FileOptions.SequentialScan), false, encoding, true, defaultBlockSize, defaultBlockSize/3, ((defaultBlockSize/3)*2)/3, defaultByteBufferLength).</summary>
  78. </member>
  79. <member name="M:FParsec.CharStream.#ctor(System.String,System.Text.Encoding,System.Boolean)">
  80. <summary>Constructs a CharStream from the file at the given path.<br/>Is equivalent to CharStream(new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.Read, 4096, FileOptions.SequentialScan), false, encoding, detectEncodingFromByteOrderMarks, defaultBlockSize, defaultBlockSize/3, ((defaultBlockSize/3)*2)/3, defaultByteBufferLength).</summary>
  81. </member>
  82. <member name="M:FParsec.CharStream.#ctor(System.String,System.Text.Encoding,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32)">
  83. <summary>Constructs a CharStream from the file at the given path.<br/>Is equivalent to CharStream(new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.Read, 4096, FileOptions.SequentialScan), false, encoding, detectEncodingFromByteOrderMarks, blockSize, blockOverlap, minRegexSpace, byteBufferLength).</summary>
  84. </member>
  85. <member name="M:FParsec.CharStream.#ctor(System.IO.Stream,System.Text.Encoding)">
  86. <summary>Constructs a CharStream from a byte Stream.<br/>Is equivalent to CharStream(stream, false, encoding, true, defaultBlockSize, defaultBlockSize/3, ((defaultBlockSize/3)*2)/3, defaultByteBufferLength).</summary>
  87. </member>
  88. <member name="M:FParsec.CharStream.#ctor(System.IO.Stream,System.Boolean,System.Text.Encoding)">
  89. <summary>Constructs a CharStream from a byte Stream.<br/>Is equivalent to CharStream(stream, leaveOpen, encoding, true, defaultBlockSize, defaultBlockSize/3, ((defaultBlockSize/3)*2)/3, defaultByteBufferLength).</summary>
  90. </member>
  91. <member name="M:FParsec.CharStream.#ctor(System.IO.Stream,System.Boolean,System.Text.Encoding,System.Boolean)">
  92. <summary>Constructs a CharStream from a byte Stream.<br/>Is equivalent to CharStream(stream, leaveOpen, encoding, detectEncodingFromByteOrderMarks, defaultBlockSize, defaultBlockSize/3, ((defaultBlockSize/3)*2)/3, defaultByteBufferLength).</summary>
  93. </member>
  94. <member name="M:FParsec.CharStream.#ctor(System.IO.Stream,System.Boolean,System.Text.Encoding,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32)">
  95. <summary>Constructs a CharStream from a byte Stream.</summary>
  96. <param name="stream">The byte stream providing the input.</param>
  97. <param name="leaveOpen">Indicates whether the byte Stream should be left open when the CharStream has finished reading it.</param>
  98. <param name="encoding">The (default) Encoding used for decoding the byte Stream into chars.</param>
  99. <param name="detectEncodingFromByteOrderMarks">Indicates whether the constructor should detect the encoding from a unicode byte-order mark at the beginning of the stream. An encoding detected from a byte-order mark overrides the default encoding.</param>
  100. <param name="blockSize">The number of chars per block. The default is 3×2^16 200k.</param>
  101. <param name="blockOverlap">The number of chars at the end of a block that are preserved when reading the next block into the char buffer. It must be less than blockSize/2, but not less than encoding.GetMaxCharCount(1). The default is blockSize/3.</param>
  102. <param name="minRegexSpace">The number of chars that are guaranteed to be visible to a regular expression when it is matched on the stream (assuming there are enough chars remaining in the stream). Must not be greater than blockOverlap. The default is 2/3 of blockOverlap.</param>
  103. <param name="byteBufferLength">The size of the byte buffer used for decoding purposes. The default is 2^12 = 4KB.</param>
  104. </member>
  105. <member name="F:FParsec.CharStream.DoNotRoundUpBlockSizeToSimplifyTesting">
  106. <summary>we modify this flag via reflection in the unit test</summary>
  107. </member>
  108. <member name="M:FParsec.CharStream.PositiveDistance(System.Char*,System.Char*)">
  109. <summary>an optimized version of end - begin, which assumes that 2^31 > end - begin >= 0. </summary>
  110. </member>
  111. <member name="M:FParsec.CharStream.Seek(System.Int64)">
  112. <summary>Returns an iterator pointing to the given index in the stream,
  113. or to the end of the stream if the indexed position lies beyond the last char in the stream.</summary>
  114. <exception cref="T:System.ArgumentOutOfRangeException">The index is negative or less than the BeginIndex.</exception>
  115. <exception cref="T:System.NotSupportedException">Accessing the char with the given index requires seeking in the underlying byte stream, but the byte stream does not support seeking or the Encoding's Decoder is not serializable.</exception>
  116. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  117. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  118. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  119. <exception cref="T:System.OutOfMemoryException">Can not allocate enough memory for the internal data structure.</exception>
  120. <exception cref="T:System.ObjectDisposedException">Method is called after the stream was disposed.</exception>
  121. </member>
  122. <member name="M:FParsec.CharStream.FoldCase(System.String)">
  123. <summary>Returns a case-folded copy of the string argument. All chars are mapped
  124. using the (non-Turkic) 1-to-1 case folding mappings (v. 5.1) for Unicode code
  125. points in the Basic Multilingual Plane, i.e. code points below 0x10000.
  126. If the argument is null, null is returned.</summary>
  127. </member>
  128. <member name="M:FParsec.CharStream.NormalizeNewlines(System.String)">
  129. <summary>Returns the given string with all occurrences of "\r\n" and "\r" replaced
  130. by "\n". If the argument is null, null is returned.</summary>
  131. </member>
  132. <member name="P:FParsec.CharStream.Encoding">
  133. <summary>The Encoding that is used for decoding the underlying byte stream, or
  134. System.Text.UnicodeEncoding in case the stream was directly constructed
  135. from a string.</summary>
  136. </member>
  137. <member name="P:FParsec.CharStream.Block">
  138. <summary>The current block in BufferString.</summary>
  139. </member>
  140. <member name="P:FParsec.CharStream.BufferCount">
  141. <summary>The number of chars in BufferString.</summary>
  142. </member>
  143. <member name="P:FParsec.CharStream.BeginIndex">
  144. <summary>The index of the first char in the stream, i.e. Begin.Index.
  145. This value is determined by the streamBeginIndex argument of some of the CharStream constructors.
  146. By default this value is 0.</summary>
  147. </member>
  148. <member name="P:FParsec.CharStream.EndIndex">
  149. <summary>The index of the last char of the stream plus 1,
  150. or Int64.MaxValue if the end of stream has not yet been detected.</summary>
  151. </member>
  152. <member name="P:FParsec.CharStream.Begin">
  153. <summary>An iterator pointing to the beginning of the stream (or to the end if the CharStream is empty).</summary>
  154. </member>
  155. <member name="F:FParsec.CharStream.BlockInfo.ByteIndex">
  156. <summary>the byte stream index of the first char in the block after the OverhangCharsAtBlockBegin</summary>
  157. </member>
  158. <member name="F:FParsec.CharStream.BlockInfo.ByteBufferIndex">
  159. <summary>the value of the CharStream's ByteBufferIndex before the block is read</summary>
  160. </member>
  161. <member name="F:FParsec.CharStream.BlockInfo.NumberOfBytesInOverlap">
  162. <summary>the number of bytes in the stream from ByteIndex to the first char after the OverhangCharsAfterOverlap</summary>
  163. </member>
  164. <member name="F:FParsec.CharStream.BlockInfo.LastCharInOverlap">
  165. <summary>the last char in the overlap with the previous block (used for integrity checking)</summary>
  166. </member>
  167. <member name="F:FParsec.CharStream.BlockInfo.OverhangCharsAtBlockBegin">
  168. <summary>chars at the block begin that were already read together with chars of the last block before the overlap</summary>
  169. </member>
  170. <member name="F:FParsec.CharStream.BlockInfo.OverhangCharsAfterOverlap">
  171. <summary>chars after the overlap with the previous block that were already read together with the overlap chars</summary>
  172. </member>
  173. <member name="T:FParsec.CharStream.Anchor">
  174. <summary>Represents the link between a CharStream and its Iterators.
  175. May be allocated on the unmanaged heap and holds a GCHandle, hence must be properly freed.</summary>
  176. </member>
  177. <member name="F:FParsec.CharStream.Anchor.LastBlock">
  178. <summary>The index of the last block of the stream, or Int32.MaxValue if the end of stream has not yet been detected.</summary>
  179. </member>
  180. <member name="F:FParsec.CharStream.Anchor.BufferBegin">
  181. <summary>Begin of the used part of the char buffer (stays constant). Is null if the CharStream is empty.</summary>
  182. </member>
  183. <member name="F:FParsec.CharStream.Anchor.BufferEnd">
  184. <summary>End of the used part of the char buffer (varies for a multi-block stream). Is null if the CharStream is empty.</summary>
  185. </member>
  186. <member name="T:FParsec.CharStream.MultiBlockData">
  187. <summary>Contains the data and methods needed in case the input byte stream
  188. is large enough to span multiple blocks of the CharStream.</summary>
  189. </member>
  190. <member name="F:FParsec.CharStream.MultiBlockData.RegexSpaceThreshold">
  191. <summary>BufferBegin + BlockSize - minRegexSpace</summary>
  192. </member>
  193. <member name="M:FParsec.CharStream.MultiBlockData.FillByteBuffer">
  194. <summary>Refills the ByteBuffer if no unused byte is remaining.
  195. Returns the number of unused bytes in the (refilled) ByteBuffer.</summary>
  196. </member>
  197. <member name="M:FParsec.CharStream.MultiBlockData.ClearAndRefillByteBuffer(System.Int32)">
  198. <summary>Refills the ByteBuffer starting at the given index. If the underlying byte
  199. stream contains enough bytes, the ByteBuffer is filled up to the ByteBuffer.Length.
  200. Returns the number of bytes available for consumption in the refilled ByteBuffer.</summary>
  201. </member>
  202. <member name="M:FParsec.CharStream.MultiBlockData.ReadCharsFromStream(System.Char*,System.Int32,System.String@)">
  203. <summary>Reads up to the given maximum number of chars into the given buffer.
  204. If more than the maximum number of chars have to be read from the stream in order to
  205. fill the buffer (due to the way the Decoder API works), the overhang chars are
  206. returned through the output parameter.
  207. Returns a pointer to one char after the last char read.</summary>
  208. </member>
  209. <member name="M:FParsec.CharStream.MultiBlockData.ReadBlock(System.Int32)">
  210. <summary> Reads a block of chars (must be different from the current block)
  211. into the BufferString. Returns a pointer to the first char of the new block,
  212. or null if no chars could be read.</summary>
  213. </member>
  214. <member name="P:FParsec.CharStream.MultiBlockData.ByteIndex">
  215. <summary>The byte stream index of the first unused byte in the ByteBuffer.</summary>
  216. </member>
  217. <member name="T:FParsec.CharStream.Iterator">
  218. <summary>The iterator type for CharStreams.</summary>
  219. </member>
  220. <member name="F:FParsec.CharStream.Iterator.EndOfStreamChar">
  221. <summary>The char returned by Read() if the iterator has
  222. reached the end of the stream. The value is '\uFFFF'.</summary>
  223. </member>
  224. <member name="F:FParsec.CharStream.Iterator.Ptr">
  225. <summary>Pointer to the current char in the CharStream's buffer (if the CharStream's current block equals Block).</summary>
  226. </member>
  227. <member name="F:FParsec.CharStream.Iterator.Block">
  228. <summary>The buffer block for which Ptr is valid.</summary>
  229. </member>
  230. <member name="M:FParsec.CharStream.Iterator.Advance(System.Int32)">
  231. <summary>Returns an Iterator that is advanced by offset chars. The Iterator can't
  232. move past the end of the stream, i.e. any position beyond the last char
  233. in the stream is interpreted as precisely one char beyond the last char.</summary>
  234. <exception cref="T:System.ArgumentOutOfRangeException">The new position would lie before the beginning of the `CharStream`.</exception>
  235. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  236. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  237. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  238. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  239. </member>
  240. <member name="M:FParsec.CharStream.Iterator.Advance(System.Int64)">
  241. <summary>Returns an Iterator that is advanced by offset chars. The Iterator can't
  242. move past the end of the stream, i.e. any position beyond the last char
  243. in the stream is interpreted as precisely one char beyond the last char.</summary>
  244. <exception cref="T:System.ArgumentOutOfRangeException">The new position would lie before the beginning of the `CharStream`.</exception>
  245. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  246. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  247. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  248. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  249. <exception cref="T:System.OutOfMemoryException">Can not allocate enough memory for the internal data structure.</exception>
  250. </member>
  251. <member name="M:FParsec.CharStream.Iterator.Advance(System.UInt32)">
  252. <summary>Returns an Iterator that is advanced by offset chars. The Iterator can't
  253. move past the end of the stream, i.e. any position beyond the last char
  254. in the stream is interpreted as precisely one char beyond the last char.</summary>
  255. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  256. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  257. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  258. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  259. </member>
  260. <member name="M:FParsec.CharStream.Iterator._Increment">
  261. <summary>Advances the Iterator *in-place* by 1 char and returns the char on the new position.
  262. `c &lt;- iter._Increment()` is equivalent to `iter &lt;- iter.Next; c &lt;- iter.Read()`.</summary>
  263. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  264. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  265. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  266. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  267. </member>
  268. <member name="M:FParsec.CharStream.Iterator._Increment(System.UInt32)">
  269. <summary>Advances the Iterator *in-place* by offset chars and returns the char on the new position.
  270. `c &lt;- iter._Increment(offset)` is an optimized implementation of `iter &lt;- iter.Advance(offset); c &lt;- iter.Read()`.</summary>
  271. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  272. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  273. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  274. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  275. </member>
  276. <member name="M:FParsec.CharStream.Iterator._Decrement">
  277. <summary>Advances the Iterator *in-place* by -1 char and returns the char on the new position,
  278. except if the Iterator already points to the beginning of the CharStream,
  279. in which case the position does not change and the EndOfStreamChar ('\uFFFF') is returned.</summary>
  280. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  281. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  282. </member>
  283. <member name="M:FParsec.CharStream.Iterator._Decrement(System.UInt32)">
  284. <summary>Advances the Iterator *in-place* by -offset chars and returns the char on the new position,
  285. except if the new position would lie before the beginning of the CharStream,
  286. in which case the Iterator is advanced to the beginning of the stream and the EndOfStreamChar ('\uFFFF') is returned.</summary>
  287. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  288. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  289. </member>
  290. <member name="M:FParsec.CharStream.Iterator._AdvanceInPlace(System.Int32)">
  291. <summary>A helper routine for optimizing State methods</summary>
  292. </member>
  293. <member name="M:FParsec.CharStream.Iterator.Peek">
  294. <summary>Is an optimized implementation of Next.Read().</summary>
  295. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  296. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  297. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  298. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  299. </member>
  300. <member name="M:FParsec.CharStream.Iterator.Peek(System.Int32)">
  301. <summary>Is an optimized implementation of Advance(offset).Read(),
  302. except that the EndOfStreamChar ('\uFFFF') is returned if Index + offset &lt; 0 (instead of an exception being thrown).</summary>
  303. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  304. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  305. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  306. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  307. </member>
  308. <member name="M:FParsec.CharStream.Iterator.Peek(System.UInt32)">
  309. <summary>Is an optimized implementation of Advance(offset).Read().</summary>
  310. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  311. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  312. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  313. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  314. </member>
  315. <member name="M:FParsec.CharStream.Iterator.Match(System.Char)">
  316. <summary>Returns true if and only if the char argument matches the char pointed to by the Iterator.
  317. At the end of the stream Match always returns false.</summary>
  318. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  319. <exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
  320. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  321. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  322. </member>
  323. <member name="M:FParsec.CharStream.Iterator.Match(System.String)">
  324. <summary>Returns true if chars matches the chars in the stream beginning with the char pointed to by the Iterator.
  325. If the chars do not match or if there are not enough chars remaining in the stream, false is returned.
  326. If chars is empty, true is returned.</summary>
  327. <exception cref="T:System.NullReferenceException">chars is null.</exception>
  328. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  329. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  330. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  331. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  332. </member>
  333. <member name="M:FParsec.CharStream.Iterator.MatchCaseFolded(System.String)">
  334. <summary>Returns true if caseFoldedChars matches the chars in the stream
  335. beginning with the char pointed to by the Iterator.
  336. The chars in the stream are case-folded before they are matched,
  337. while the chars in the string argument are assumed to already be case-folded.
  338. If the chars do not match or if there are not enough chars remaining in the stream, false is returned.
  339. If caseFoldedChars is empty, true is returned.</summary>
  340. <exception cref="T:System.NullReferenceException">caseFoldedChars is null.</exception>
  341. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  342. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  343. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  344. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  345. </member>
  346. <member name="M:FParsec.CharStream.Iterator.Match(System.String,System.Int32,System.Int32)">
  347. <summary>Returns true if the chars in chars between the indices charsIndex (inclusive) and
  348. charsIndex + length (exclusive) match the chars in the stream beginning with the char pointed to by the Iterator.
  349. If the chars do not match or if there are not enough chars remaining in the stream, false is returned.
  350. If length is 0, true is returned.</summary>
  351. <exception cref="T:System.ArgumentOutOfRangeException">charsIndex is negative, length is negative or charsIndex + length &gt; chars.Length.</exception>
  352. <exception cref="T:System.NullReferenceException">chars is null.</exception>
  353. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  354. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  355. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  356. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  357. </member>
  358. <member name="M:FParsec.CharStream.Iterator.Match(System.Char[],System.Int32,System.Int32)">
  359. <summary>Returns true if the chars in the char array between the indices charsIndex (inclusive) and
  360. charsIndex + length (exclusive) match the chars in the stream beginning with the char pointed to by the Iterator.
  361. If the chars do not match or if there are not enough chars remaining in the stream, false is returned.
  362. If length is 0, true is returned.</summary>
  363. <exception cref="T:System.ArgumentOutOfRangeException">charsIndex is negative, length is negative or charsIndex + length &gt; chars.Length.</exception>
  364. <exception cref="T:System.NullReferenceException">chars is null.</exception>
  365. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  366. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  367. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  368. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  369. </member>
  370. <member name="M:FParsec.CharStream.Iterator.Match(System.Char*,System.Int32)">
  371. <summary>Returns true if the length chars at the pointer address match the chars
  372. in the stream beginning with the char pointed to by the Iterator.
  373. If the chars do not match or if there are not enough chars remaining in the stream,
  374. false is returned. If length is 0, true is returned.</summary>
  375. <exception cref="T:System.ArgumentOutOfRangeException">length is negative.</exception>
  376. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  377. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  378. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  379. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  380. </member>
  381. <member name="M:FParsec.CharStream.Iterator.MatchCaseFolded(System.Char*,System.Int32)">
  382. <summary>Returns true if the length chars at the pointer address match the chars
  383. in the stream beginning with the char pointed to by the Iterator.
  384. The chars in the stream are case-folded before they are matched,
  385. while the chars at the pointer address are assumed to already be case-folded.
  386. If the chars do not match or if there are not enough chars remaining in the stream,
  387. false is returned. If length is 0, true is returned.</summary>
  388. <exception cref="T:System.ArgumentOutOfRangeException">length is negative.</exception>
  389. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  390. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  391. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  392. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  393. </member>
  394. <member name="M:FParsec.CharStream.Iterator.Match(System.Text.RegularExpressions.Regex)">
  395. <summary>Applies the given regular expression to stream chars beginning with the char pointed to by the Iterator.
  396. Returns the resulting Match object. (Not supported by CharStreams constructed from char arrays or pointers.)</summary>
  397. <remarks><para>For performance reasons you should specify the regular expression
  398. such that it can only match at the beginning of a string,
  399. for example by prepending "\A".</para>
  400. <para>For CharStreams constructed from large binary streams the regular expression is not applied
  401. to a string containing all the remaining chars in the stream. The minRegexSpace parameter
  402. of the CharStream constructors determines the minimum number of chars that are guaranteed
  403. to be visible to the regular expression.</para>
  404. <para>
  405. IMPORTANT:<br/>
  406. If the CharStream has been constructed from a System.IO.Stream or a file path, the regular expression is
  407. applied to an internal mutable buffer. Since the Match object may work lazily, i.e. compute matched strings
  408. not before they are needed, you need to retrieve all the required information from the Match object before
  409. you continue to access the CharStream, otherwise you might get invalid results.</para>
  410. </remarks>
  411. <exception cref="T:System.NullReferenceException">regex is null.</exception>
  412. <exception cref="T:System.NotSupportedException">Two possible reasons: 1) The CharStream was constructed from a char array or char pointer, in which case it does not support regular expression matching.
  413. 2) Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  414. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  415. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  416. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  417. </member>
  418. <member name="M:FParsec.CharStream.Iterator.Read">
  419. <summary>Returns the stream char pointed to by the Iterator,
  420. or the EndOfStreamChar ('\uFFFF') if the Iterator has reached the end of the stream.</summary>
  421. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  422. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  423. </member>
  424. <member name="M:FParsec.CharStream.Iterator.Read2">
  425. <summary>Is an optimized implementation of new TwoChars(Read(), Next.Read()).</summary>
  426. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  427. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  428. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  429. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  430. </member>
  431. <member name="M:FParsec.CharStream.Iterator.Read(System.Int32)">
  432. <summary>Returns a string with the length stream chars beginning with the char pointed to by the Iterator.
  433. If less than length chars are remaining in the stream, only the remaining chars are returned.</summary>
  434. <exception cref="T:System.ArgumentOutOfRangeException">length is negative.</exception>
  435. <exception cref="T:System.OutOfMemoryException">There is not enough memory for the string or the requested string is too large.</exception>
  436. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  437. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  438. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  439. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  440. </member>
  441. <member name="M:FParsec.CharStream.Iterator.Read(System.Int32,System.Boolean)">
  442. <summary>Returns a string with the length stream chars beginning with the char pointed to by the Iterator.
  443. If less than length chars are remaining in the stream,
  444. only the remaining chars are returned, or an empty string if allOrEmpty is true.</summary>
  445. <exception cref="T:System.ArgumentOutOfRangeException">length is negative.</exception>
  446. <exception cref="T:System.OutOfMemoryException">There is not enough memory for the string or the requested string is too large.</exception>
  447. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  448. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  449. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  450. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  451. </member>
  452. <member name="M:FParsec.CharStream.Iterator.Read(System.Char[],System.Int32,System.Int32)">
  453. <summary>Copies the length stream chars beginning with the char pointed to by the Iterator into buffer.
  454. The chars are written into buffer beginning at the index bufferIndex.
  455. If less than length chars are remaining in the stream, only the remaining chars are copied.
  456. Returns the actual number of chars copied.</summary>
  457. <exception cref="T:System.ArgumentOutOfRangeException">bufferIndex is negative, length is negative or bufferIndex + length &gt; buffer.Length.</exception>
  458. <exception cref="T:System.NullReferenceException">buffer is null.</exception>
  459. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  460. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  461. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  462. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  463. </member>
  464. <member name="M:FParsec.CharStream.Iterator.Read(System.Char*,System.Int32)">
  465. <summary>Copies the length stream chars beginning with the char pointed to by the Iterator into the buffer at the given pointer address.
  466. If less than length chars are remaining in the stream, only the remaining chars are copied.
  467. Returns the actual number of chars copied.</summary>
  468. <exception cref="T:System.NullReferenceException">buffer is null.</exception>
  469. <exception cref="T:System.ArgumentOutOfRangeException">length is negative.</exception>
  470. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  471. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  472. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  473. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  474. </member>
  475. <member name="M:FParsec.CharStream.Iterator.ReadUntil(FParsec.CharStream.Iterator)">
  476. <summary>Returns a string with all the chars in the stream between the position of this Iterator (inclusive)
  477. and the position of the Iterator in the argument (exclusive).
  478. If the Iterator argument does not point to a position after the position of this Iterator, the returned string is empty.</summary>
  479. <exception cref="T:System.ArgumentOutOfRangeException">iterToCharAfterLastInString belongs to a different CharStream.</exception>
  480. <exception cref="T:System.OutOfMemoryException">There is not enough memory for the string or the requested string is too large.</exception>
  481. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  482. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  483. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  484. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  485. </member>
  486. <member name="P:FParsec.CharStream.Iterator.Stream">
  487. <summary>The CharStream over which the Iterator iterates.</summary>
  488. </member>
  489. <member name="P:FParsec.CharStream.Iterator.IsBeginOfStream">
  490. <summary>Indicates whether the Iterator points to the beginning of the CharStream.
  491. If the CharStream is empty, this property is always true.</summary>
  492. </member>
  493. <member name="P:FParsec.CharStream.Iterator.IsEndOfStream">
  494. <summary>Indicates whether the Iterator points to the end of the CharStream,
  495. i.e. whether it points to one char beyond the last char in the CharStream.</summary>
  496. </member>
  497. <member name="P:FParsec.CharStream.Iterator.Index">
  498. <summary>The index of the stream char pointed to by the Iterator.</summary>
  499. </member>
  500. <member name="P:FParsec.CharStream.Iterator.Next">
  501. <summary>Returns an Iterator pointing to the next char in the stream. If the Iterator already
  502. has reached the end of the stream, i.e. if it points to one char beyond
  503. the last char, the same Iterator is returned.</summary>
  504. <exception cref="T:System.NotSupportedException">Seeking of the underlying byte stream is required, but the byte stream does not support seeking or the Encodings's Decoder is not serializable.</exception>
  505. <exception cref="T:System.IO.IOException">An I/O error occured.</exception>
  506. <exception cref="T:System.ArgumentException">The input stream contains invalid bytes and the encoding was constructed with the throwOnInvalidBytes option.</exception>
  507. <exception cref="T:System.Text.DecoderFallbackException">The input stream contains invalid bytes for which the decoder fallback threw this exception.</exception>
  508. </member>
  509. <member name="M:FParsec.Helper.DetectPreamble(System.Byte[],System.Int32,System.Text.Encoding@,System.Boolean)">
  510. <summary>Detects the presence of an encoding preamble in the first count bytes of the byte buffer.
  511. If detectEncoding is false, this function only searches for the preamble of the given default encoding,
  512. otherwise also for any of the standard unicode byte order marks (UTF-8, UTF-16 LE/BE, UTF-32 LE/BE).
  513. If an encoding different from the given default encoding is detected, the new encoding
  514. is assigned to the encoding reference.
  515. Returns the number of bytes in the detected preamble, or 0 if no preamble is detected.
  516. </summary>
  517. </member>
  518. <member name="M:FParsec.Helper.CountTextElements(System.String)">
  519. <summary>A faster implementation of System.Globalization.StringInfo(str).LengthInTextElements.</summary>
  520. </member>
  521. <member name="T:FParsec.Helper.UTF8EncodingWithNonSerializableDecoder.NonSerializableUTF8Decoder">
  522. <summary>Needed for Test.CharStreamTests and can't be implemented in F#.</summary>
  523. </member>
  524. </members>
  525. </doc>