Microsoft.Extensions.Primitives.xml 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Primitives</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Primitives.CancellationChangeToken">
  8. <summary>
  9. A <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> implementation using <see cref="T:System.Threading.CancellationToken"/>.
  10. </summary>
  11. </member>
  12. <member name="M:Microsoft.Extensions.Primitives.CancellationChangeToken.#ctor(System.Threading.CancellationToken)">
  13. <summary>
  14. Initializes a new instance of <see cref="T:Microsoft.Extensions.Primitives.CancellationChangeToken"/>.
  15. </summary>
  16. <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>
  17. </member>
  18. <member name="P:Microsoft.Extensions.Primitives.CancellationChangeToken.ActiveChangeCallbacks">
  19. <inheritdoc />
  20. </member>
  21. <member name="P:Microsoft.Extensions.Primitives.CancellationChangeToken.HasChanged">
  22. <inheritdoc />
  23. </member>
  24. <member name="M:Microsoft.Extensions.Primitives.CancellationChangeToken.RegisterChangeCallback(System.Action{System.Object},System.Object)">
  25. <inheritdoc />
  26. </member>
  27. <member name="T:Microsoft.Extensions.Primitives.ChangeToken">
  28. <summary>
  29. Propagates notifications that a change has occurred.
  30. </summary>
  31. </member>
  32. <member name="M:Microsoft.Extensions.Primitives.ChangeToken.OnChange(System.Func{Microsoft.Extensions.Primitives.IChangeToken},System.Action)">
  33. <summary>
  34. Registers the <paramref name="changeTokenConsumer"/> action to be called whenever the token produced changes.
  35. </summary>
  36. <param name="changeTokenProducer">Produces the change token.</param>
  37. <param name="changeTokenConsumer">Action called when the token changes.</param>
  38. <returns></returns>
  39. </member>
  40. <member name="M:Microsoft.Extensions.Primitives.ChangeToken.OnChange``1(System.Func{Microsoft.Extensions.Primitives.IChangeToken},System.Action{``0},``0)">
  41. <summary>
  42. Registers the <paramref name="changeTokenConsumer"/> action to be called whenever the token produced changes.
  43. </summary>
  44. <param name="changeTokenProducer">Produces the change token.</param>
  45. <param name="changeTokenConsumer">Action called when the token changes.</param>
  46. <param name="state">state for the consumer.</param>
  47. <returns></returns>
  48. </member>
  49. <member name="T:Microsoft.Extensions.Primitives.CompositeChangeToken">
  50. <summary>
  51. An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> which represents one or more <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> instances.
  52. </summary>
  53. </member>
  54. <member name="M:Microsoft.Extensions.Primitives.CompositeChangeToken.#ctor(System.Collections.Generic.IReadOnlyList{Microsoft.Extensions.Primitives.IChangeToken})">
  55. <summary>
  56. Creates a new instance of <see cref="T:Microsoft.Extensions.Primitives.CompositeChangeToken"/>.
  57. </summary>
  58. <param name="changeTokens">The list of <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> to compose.</param>
  59. </member>
  60. <member name="P:Microsoft.Extensions.Primitives.CompositeChangeToken.ChangeTokens">
  61. <summary>
  62. Returns the list of <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> which compose the current <see cref="T:Microsoft.Extensions.Primitives.CompositeChangeToken"/>.
  63. </summary>
  64. </member>
  65. <member name="M:Microsoft.Extensions.Primitives.CompositeChangeToken.RegisterChangeCallback(System.Action{System.Object},System.Object)">
  66. <inheritdoc />
  67. </member>
  68. <member name="P:Microsoft.Extensions.Primitives.CompositeChangeToken.HasChanged">
  69. <inheritdoc />
  70. </member>
  71. <member name="P:Microsoft.Extensions.Primitives.CompositeChangeToken.ActiveChangeCallbacks">
  72. <inheritdoc />
  73. </member>
  74. <member name="M:Microsoft.Extensions.Primitives.Extensions.Append(System.Text.StringBuilder,Microsoft.Extensions.Primitives.StringSegment)">
  75. <summary>
  76. Add the given <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to the <see cref="T:System.Text.StringBuilder"/>.
  77. </summary>
  78. <param name="builder">The <see cref="T:System.Text.StringBuilder"/> to add to.</param>
  79. <param name="segment">The <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to add.</param>
  80. <returns>The original <see cref="T:System.Text.StringBuilder"/>.</returns>
  81. </member>
  82. <member name="T:Microsoft.Extensions.Primitives.IChangeToken">
  83. <summary>
  84. Propagates notifications that a change has occurred.
  85. </summary>
  86. </member>
  87. <member name="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged">
  88. <summary>
  89. Gets a value that indicates if a change has occurred.
  90. </summary>
  91. </member>
  92. <member name="P:Microsoft.Extensions.Primitives.IChangeToken.ActiveChangeCallbacks">
  93. <summary>
  94. Indicates if this token will pro-actively raise callbacks. If <c>false</c>, the token consumer must
  95. poll <see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged" /> to detect changes.
  96. </summary>
  97. </member>
  98. <member name="M:Microsoft.Extensions.Primitives.IChangeToken.RegisterChangeCallback(System.Action{System.Object},System.Object)">
  99. <summary>
  100. Registers for a callback that will be invoked when the entry has changed.
  101. <see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged"/> MUST be set before the callback is invoked.
  102. </summary>
  103. <param name="callback">The <see cref="T:System.Action`1"/> to invoke.</param>
  104. <param name="state">State to be passed into the callback.</param>
  105. <returns>An <see cref="T:System.IDisposable"/> that is used to unregister the callback.</returns>
  106. </member>
  107. <member name="T:Microsoft.Extensions.Primitives.StringSegment">
  108. <summary>
  109. An optimized representation of a substring.
  110. </summary>
  111. </member>
  112. <member name="F:Microsoft.Extensions.Primitives.StringSegment.Empty">
  113. <summary>
  114. A <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> for <see cref="F:System.String.Empty"/>.
  115. </summary>
  116. </member>
  117. <member name="M:Microsoft.Extensions.Primitives.StringSegment.#ctor(System.String)">
  118. <summary>
  119. Initializes an instance of the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> struct.
  120. </summary>
  121. <param name="buffer">
  122. The original <see cref="T:System.String"/>. The <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> includes the whole <see cref="T:System.String"/>.
  123. </param>
  124. </member>
  125. <member name="M:Microsoft.Extensions.Primitives.StringSegment.#ctor(System.String,System.Int32,System.Int32)">
  126. <summary>
  127. Initializes an instance of the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> struct.
  128. </summary>
  129. <param name="buffer">The original <see cref="T:System.String"/> used as buffer.</param>
  130. <param name="offset">The offset of the segment within the <paramref name="buffer"/>.</param>
  131. <param name="length">The length of the segment.</param>
  132. <exception cref="T:System.ArgumentNullException">
  133. <paramref name="buffer"/> is <code>null</code>.
  134. </exception>
  135. <exception cref="T:System.ArgumentOutOfRangeException">
  136. <paramref name="offset"/> or <paramref name="length"/> is less than zero, or <paramref name="offset"/> +
  137. <paramref name="length"/> is greater than the number of characters in <paramref name="buffer"/>.
  138. </exception>
  139. </member>
  140. <member name="P:Microsoft.Extensions.Primitives.StringSegment.Buffer">
  141. <summary>
  142. Gets the <see cref="T:System.String"/> buffer for this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
  143. </summary>
  144. </member>
  145. <member name="P:Microsoft.Extensions.Primitives.StringSegment.Offset">
  146. <summary>
  147. Gets the offset within the buffer for this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
  148. </summary>
  149. </member>
  150. <member name="P:Microsoft.Extensions.Primitives.StringSegment.Length">
  151. <summary>
  152. Gets the length of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
  153. </summary>
  154. </member>
  155. <member name="P:Microsoft.Extensions.Primitives.StringSegment.Value">
  156. <summary>
  157. Gets the value of this segment as a <see cref="T:System.String"/>.
  158. </summary>
  159. </member>
  160. <member name="P:Microsoft.Extensions.Primitives.StringSegment.HasValue">
  161. <summary>
  162. Gets whether this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> contains a valid value.
  163. </summary>
  164. </member>
  165. <member name="P:Microsoft.Extensions.Primitives.StringSegment.Item(System.Int32)">
  166. <summary>
  167. Gets the <see cref="T:System.Char"/> at a specified position in the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
  168. </summary>
  169. <param name="index">The offset into the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/></param>
  170. <returns>The <see cref="T:System.Char"/> at a specified position.</returns>
  171. <exception cref="T:System.ArgumentOutOfRangeException">
  172. <paramref name="index"/> is greater than or equal to <see cref="P:Microsoft.Extensions.Primitives.StringSegment.Length"/> or less than zero.
  173. </exception>
  174. </member>
  175. <member name="M:Microsoft.Extensions.Primitives.StringSegment.AsSpan">
  176. <summary>
  177. Gets a <see cref="T:System.ReadOnlySpan`1"/> from the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
  178. </summary>
  179. <returns>The <see cref="T:System.ReadOnlySpan`1"/> from this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</returns>
  180. </member>
  181. <member name="M:Microsoft.Extensions.Primitives.StringSegment.AsMemory">
  182. <summary>
  183. Gets a <see cref="T:System.ReadOnlyMemory`1"/> from the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
  184. </summary>
  185. <returns>The <see cref="T:System.ReadOnlyMemory`1"/> from this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</returns>
  186. </member>
  187. <member name="M:Microsoft.Extensions.Primitives.StringSegment.Compare(Microsoft.Extensions.Primitives.StringSegment,Microsoft.Extensions.Primitives.StringSegment,System.StringComparison)">
  188. <summary>
  189. Compares substrings of two specified <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> objects using the specified rules,
  190. and returns an integer that indicates their relative position in the sort order.
  191. </summary>
  192. <param name="a">The first <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to compare.</param>
  193. <param name="b">The second <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to compare.</param>
  194. <param name="comparisonType">One of the enumeration values that specifies the rules for the comparison.</param>
  195. <returns>
  196. A 32-bit signed integer indicating the lexical relationship between the two comparands.
  197. The value is negative if <paramref name="a"/> is less than <paramref name="b"/>, 0 if the two comparands are equal,
  198. and positive if <paramref name="a"/> is greater than <paramref name="b"/>.
  199. </returns>
  200. </member>
  201. <member name="M:Microsoft.Extensions.Primitives.StringSegment.Equals(System.Object)">
  202. <inheritdoc />
  203. </member>
  204. <member name="M:Microsoft.Extensions.Primitives.StringSegment.Equals(Microsoft.Extensions.Primitives.StringSegment)">
  205. <summary>
  206. Indicates whether the current object is equal to another object of the same type.
  207. </summary>
  208. <param name="other">An object to compare with this object.</param>
  209. <returns><code>true</code> if the current object is equal to the other parameter; otherwise, <code>false</code>.</returns>
  210. </member>
  211. <member name="M:Microsoft.Extensions.Primitives.StringSegment.Equals(Microsoft.Extensions.Primitives.StringSegment,System.StringComparison)">
  212. <summary>
  213. Indicates whether the current object is equal to another object of the same type.
  214. </summary>
  215. <param name="other">An object to compare with this object.</param>
  216. <param name="comparisonType">One of the enumeration values that specifies the rules to use in the comparison.</param>
  217. <returns><code>true</code> if the current object is equal to the other parameter; otherwise, <code>false</code>.</returns>
  218. </member>
  219. <member name="M:Microsoft.Extensions.Primitives.StringSegment.Equals(Microsoft.Extensions.Primitives.StringSegment,Microsoft.Extensions.Primitives.StringSegment,System.StringComparison)">
  220. <summary>
  221. Determines whether two specified <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> objects have the same value. A parameter specifies the culture, case, and
  222. sort rules used in the comparison.
  223. </summary>
  224. <param name="a">The first <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to compare.</param>
  225. <param name="b">The second <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to compare.</param>
  226. <param name="comparisonType">One of the enumeration values that specifies the rules for the comparison.</param>
  227. <returns><code>true</code> if the objects are equal; otherwise, <code>false</code>.</returns>
  228. </member>
  229. <member name="M:Microsoft.Extensions.Primitives.StringSegment.Equals(System.String)">
  230. <summary>
  231. Checks if the specified <see cref="T:System.String"/> is equal to the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
  232. </summary>
  233. <param name="text">The <see cref="T:System.String"/> to compare with the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</param>
  234. <returns><code>true</code> if the specified <see cref="T:System.String"/> is equal to the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>; otherwise, <code>false</code>.</returns>
  235. </member>
  236. <member name="M:Microsoft.Extensions.Primitives.StringSegment.Equals(System.String,System.StringComparison)">
  237. <summary>
  238. Checks if the specified <see cref="T:System.String"/> is equal to the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
  239. </summary>
  240. <param name="text">The <see cref="T:System.String"/> to compare with the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</param>
  241. <param name="comparisonType">One of the enumeration values that specifies the rules to use in the comparison.</param>
  242. <returns><code>true</code> if the specified <see cref="T:System.String"/> is equal to the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>; otherwise, <code>false</code>.</returns>
  243. <exception cref="T:System.ArgumentNullException">
  244. <paramref name="text"/> is <code>null</code>.
  245. </exception>
  246. </member>
  247. <member name="M:Microsoft.Extensions.Primitives.StringSegment.GetHashCode">
  248. <inheritdoc />
  249. </member>
  250. <member name="M:Microsoft.Extensions.Primitives.StringSegment.op_Equality(Microsoft.Extensions.Primitives.StringSegment,Microsoft.Extensions.Primitives.StringSegment)">
  251. <summary>
  252. Checks if two specified <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> have the same value.
  253. </summary>
  254. <param name="left">The first <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to compare, or <code>null</code>.</param>
  255. <param name="right">The second <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to compare, or <code>null</code>.</param>
  256. <returns><code>true</code> if the value of <paramref name="left"/> is the same as the value of <paramref name="right"/>; otherwise, <code>false</code>.</returns>
  257. </member>
  258. <member name="M:Microsoft.Extensions.Primitives.StringSegment.op_Inequality(Microsoft.Extensions.Primitives.StringSegment,Microsoft.Extensions.Primitives.StringSegment)">
  259. <summary>
  260. Checks if two specified <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> have different values.
  261. </summary>
  262. <param name="left">The first <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to compare, or <code>null</code>.</param>
  263. <param name="right">The second <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to compare, or <code>null</code>.</param>
  264. <returns><code>true</code> if the value of <paramref name="left"/> is different from the value of <paramref name="right"/>; otherwise, <code>false</code>.</returns>
  265. </member>
  266. <member name="M:Microsoft.Extensions.Primitives.StringSegment.op_Implicit(System.String)~Microsoft.Extensions.Primitives.StringSegment">
  267. <summary>
  268. Creates a new <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> from the given <see cref="T:System.String"/>.
  269. </summary>
  270. <param name="value">The <see cref="T:System.String"/> to convert to a <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/></param>
  271. </member>
  272. <member name="M:Microsoft.Extensions.Primitives.StringSegment.op_Implicit(Microsoft.Extensions.Primitives.StringSegment)~System.ReadOnlySpan{System.Char}">
  273. <summary>
  274. Creates a see <see cref="T:System.ReadOnlySpan`1"/> from the given <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
  275. </summary>
  276. <param name="segment">The <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to convert to a <see cref="T:System.ReadOnlySpan`1"/>.</param>
  277. </member>
  278. <member name="M:Microsoft.Extensions.Primitives.StringSegment.op_Implicit(Microsoft.Extensions.Primitives.StringSegment)~System.ReadOnlyMemory{System.Char}">
  279. <summary>
  280. Creates a see <see cref="T:System.ReadOnlyMemory`1"/> from the given <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
  281. </summary>
  282. <param name="segment">The <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to convert to a <see cref="T:System.ReadOnlyMemory`1"/>.</param>
  283. </member>
  284. <member name="M:Microsoft.Extensions.Primitives.StringSegment.StartsWith(System.String,System.StringComparison)">
  285. <summary>
  286. Checks if the beginning of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> matches the specified <see cref="T:System.String"/> when compared using the specified <paramref name="comparisonType"/>.
  287. </summary>
  288. <param name="text">The <see cref="T:System.String"/>to compare.</param>
  289. <param name="comparisonType">One of the enumeration values that specifies the rules to use in the comparison.</param>
  290. <returns><code>true</code> if <paramref name="text"/> matches the beginning of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>; otherwise, <code>false</code>.</returns>
  291. <exception cref="T:System.ArgumentNullException">
  292. <paramref name="text"/> is <code>null</code>.
  293. </exception>
  294. </member>
  295. <member name="M:Microsoft.Extensions.Primitives.StringSegment.EndsWith(System.String,System.StringComparison)">
  296. <summary>
  297. Checks if the end of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> matches the specified <see cref="T:System.String"/> when compared using the specified <paramref name="comparisonType"/>.
  298. </summary>
  299. <param name="text">The <see cref="T:System.String"/>to compare.</param>
  300. <param name="comparisonType">One of the enumeration values that specifies the rules to use in the comparison.</param>
  301. <returns><code>true</code> if <paramref name="text"/> matches the end of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>; otherwise, <code>false</code>.</returns>
  302. <exception cref="T:System.ArgumentNullException">
  303. <paramref name="text"/> is <code>null</code>.
  304. </exception>
  305. </member>
  306. <member name="M:Microsoft.Extensions.Primitives.StringSegment.Substring(System.Int32)">
  307. <summary>
  308. Retrieves a substring from this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
  309. The substring starts at the position specified by <paramref name="offset"/> and has the remaining length.
  310. </summary>
  311. <param name="offset">The zero-based starting character position of a substring in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</param>
  312. <returns>A <see cref="T:System.String"/> that is equivalent to the substring of remaining length that begins at
  313. <paramref name="offset"/> in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/></returns>
  314. <exception cref="T:System.ArgumentOutOfRangeException">
  315. <paramref name="offset"/> is greater than or equal to <see cref="P:Microsoft.Extensions.Primitives.StringSegment.Length"/> or less than zero.
  316. </exception>
  317. </member>
  318. <member name="M:Microsoft.Extensions.Primitives.StringSegment.Substring(System.Int32,System.Int32)">
  319. <summary>
  320. Retrieves a substring from this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
  321. The substring starts at the position specified by <paramref name="offset"/> and has the specified <paramref name="length"/>.
  322. </summary>
  323. <param name="offset">The zero-based starting character position of a substring in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</param>
  324. <param name="length">The number of characters in the substring.</param>
  325. <returns>A <see cref="T:System.String"/> that is equivalent to the substring of length <paramref name="length"/> that begins at
  326. <paramref name="offset"/> in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/></returns>
  327. <exception cref="T:System.ArgumentOutOfRangeException">
  328. <paramref name="offset"/> or <paramref name="length"/> is less than zero, or <paramref name="offset"/> + <paramref name="length"/> is
  329. greater than <see cref="P:Microsoft.Extensions.Primitives.StringSegment.Length"/>.
  330. </exception>
  331. </member>
  332. <member name="M:Microsoft.Extensions.Primitives.StringSegment.Subsegment(System.Int32)">
  333. <summary>
  334. Retrieves a <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> that represents a substring from this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
  335. The <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> starts at the position specified by <paramref name="offset"/>.
  336. </summary>
  337. <param name="offset">The zero-based starting character position of a substring in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</param>
  338. <returns>A <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> that begins at <paramref name="offset"/> in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>
  339. whose length is the remainder.</returns>
  340. <exception cref="T:System.ArgumentOutOfRangeException">
  341. <paramref name="offset"/> is greater than or equal to <see cref="P:Microsoft.Extensions.Primitives.StringSegment.Length"/> or less than zero.
  342. </exception>
  343. </member>
  344. <member name="M:Microsoft.Extensions.Primitives.StringSegment.Subsegment(System.Int32,System.Int32)">
  345. <summary>
  346. Retrieves a <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> that represents a substring from this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
  347. The <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> starts at the position specified by <paramref name="offset"/> and has the specified <paramref name="length"/>.
  348. </summary>
  349. <param name="offset">The zero-based starting character position of a substring in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</param>
  350. <param name="length">The number of characters in the substring.</param>
  351. <returns>A <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> that is equivalent to the substring of length <paramref name="length"/> that begins at <paramref name="offset"/> in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/></returns>
  352. <exception cref="T:System.ArgumentOutOfRangeException">
  353. <paramref name="offset"/> or <paramref name="length"/> is less than zero, or <paramref name="offset"/> + <paramref name="length"/> is
  354. greater than <see cref="P:Microsoft.Extensions.Primitives.StringSegment.Length"/>.
  355. </exception>
  356. </member>
  357. <member name="M:Microsoft.Extensions.Primitives.StringSegment.IndexOf(System.Char,System.Int32,System.Int32)">
  358. <summary>
  359. Gets the zero-based index of the first occurrence of the character <paramref name="c"/> in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
  360. The search starts at <paramref name="start"/> and examines a specified number of <paramref name="count"/> character positions.
  361. </summary>
  362. <param name="c">The Unicode character to seek.</param>
  363. <param name="start">The zero-based index position at which the search starts. </param>
  364. <param name="count">The number of characters to examine.</param>
  365. <returns>The zero-based index position of <paramref name="c"/> from the beginning of the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> if that character is found, or -1 if it is not.</returns>
  366. <exception cref="T:System.ArgumentOutOfRangeException">
  367. <paramref name="start"/> or <paramref name="count"/> is less than zero, or <paramref name="start"/> + <paramref name="count"/> is
  368. greater than <see cref="P:Microsoft.Extensions.Primitives.StringSegment.Length"/>.
  369. </exception>
  370. </member>
  371. <member name="M:Microsoft.Extensions.Primitives.StringSegment.IndexOf(System.Char,System.Int32)">
  372. <summary>
  373. Gets the zero-based index of the first occurrence of the character <paramref name="c"/> in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
  374. The search starts at <paramref name="start"/>.
  375. </summary>
  376. <param name="c">The Unicode character to seek.</param>
  377. <param name="start">The zero-based index position at which the search starts. </param>
  378. <returns>The zero-based index position of <paramref name="c"/> from the beginning of the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> if that character is found, or -1 if it is not.</returns>
  379. <exception cref="T:System.ArgumentOutOfRangeException">
  380. <paramref name="start"/> is greater than or equal to <see cref="P:Microsoft.Extensions.Primitives.StringSegment.Length"/> or less than zero.
  381. </exception>
  382. </member>
  383. <member name="M:Microsoft.Extensions.Primitives.StringSegment.IndexOf(System.Char)">
  384. <summary>
  385. Gets the zero-based index of the first occurrence of the character <paramref name="c"/> in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
  386. </summary>
  387. <param name="c">The Unicode character to seek.</param>
  388. <returns>The zero-based index position of <paramref name="c"/> from the beginning of the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> if that character is found, or -1 if it is not.</returns>
  389. </member>
  390. <member name="M:Microsoft.Extensions.Primitives.StringSegment.IndexOfAny(System.Char[],System.Int32,System.Int32)">
  391. <summary>
  392. Reports the zero-based index of the first occurrence in this instance of any character in a specified array
  393. of Unicode characters. The search starts at a specified character position and examines a specified number
  394. of character positions.
  395. </summary>
  396. <param name="anyOf">A Unicode character array containing one or more characters to seek.</param>
  397. <param name="startIndex">The search starting position.</param>
  398. <param name="count">The number of character positions to examine.</param>
  399. <returns>The zero-based index position of the first occurrence in this instance where any character in <paramref name="anyOf"/>
  400. was found; -1 if no character in <paramref name="anyOf"/> was found.</returns>
  401. <exception cref="T:System.ArgumentNullException">
  402. <paramref name="anyOf"/> is <code>null</code>.
  403. </exception>
  404. <exception cref="T:System.ArgumentOutOfRangeException">
  405. <paramref name="startIndex"/> or <paramref name="count"/> is less than zero, or <paramref name="startIndex"/> + <paramref name="count"/> is
  406. greater than <see cref="P:Microsoft.Extensions.Primitives.StringSegment.Length"/>.
  407. </exception>
  408. </member>
  409. <member name="M:Microsoft.Extensions.Primitives.StringSegment.IndexOfAny(System.Char[],System.Int32)">
  410. <summary>
  411. Reports the zero-based index of the first occurrence in this instance of any character in a specified array
  412. of Unicode characters. The search starts at a specified character position.
  413. </summary>
  414. <param name="anyOf">A Unicode character array containing one or more characters to seek.</param>
  415. <param name="startIndex">The search starting position.</param>
  416. <returns>The zero-based index position of the first occurrence in this instance where any character in <paramref name="anyOf"/>
  417. was found; -1 if no character in <paramref name="anyOf"/> was found.</returns>
  418. <exception cref="T:System.ArgumentOutOfRangeException">
  419. <paramref name="startIndex"/> is greater than or equal to <see cref="P:Microsoft.Extensions.Primitives.StringSegment.Length"/> or less than zero.
  420. </exception>
  421. </member>
  422. <member name="M:Microsoft.Extensions.Primitives.StringSegment.IndexOfAny(System.Char[])">
  423. <summary>
  424. Reports the zero-based index of the first occurrence in this instance of any character in a specified array
  425. of Unicode characters.
  426. </summary>
  427. <param name="anyOf">A Unicode character array containing one or more characters to seek.</param>
  428. <returns>The zero-based index position of the first occurrence in this instance where any character in <paramref name="anyOf"/>
  429. was found; -1 if no character in <paramref name="anyOf"/> was found.</returns>
  430. </member>
  431. <member name="M:Microsoft.Extensions.Primitives.StringSegment.LastIndexOf(System.Char)">
  432. <summary>
  433. Reports the zero-based index position of the last occurrence of a specified Unicode character within this instance.
  434. </summary>
  435. <param name="value">The Unicode character to seek.</param>
  436. <returns>The zero-based index position of value if that character is found, or -1 if it is not.</returns>
  437. </member>
  438. <member name="M:Microsoft.Extensions.Primitives.StringSegment.Trim">
  439. <summary>
  440. Removes all leading and trailing whitespaces.
  441. </summary>
  442. <returns>The trimmed <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</returns>
  443. </member>
  444. <member name="M:Microsoft.Extensions.Primitives.StringSegment.TrimStart">
  445. <summary>
  446. Removes all leading whitespaces.
  447. </summary>
  448. <returns>The trimmed <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</returns>
  449. </member>
  450. <member name="M:Microsoft.Extensions.Primitives.StringSegment.TrimEnd">
  451. <summary>
  452. Removes all trailing whitespaces.
  453. </summary>
  454. <returns>The trimmed <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</returns>
  455. </member>
  456. <member name="M:Microsoft.Extensions.Primitives.StringSegment.Split(System.Char[])">
  457. <summary>
  458. Splits a string into <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>s that are based on the characters in an array.
  459. </summary>
  460. <param name="chars">A character array that delimits the substrings in this string, an empty array that
  461. contains no delimiters, or null.</param>
  462. <returns>An <see cref="T:Microsoft.Extensions.Primitives.StringTokenizer"/> whose elements contain the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>s from this instance
  463. that are delimited by one or more characters in <paramref name="chars"/>.</returns>
  464. </member>
  465. <member name="M:Microsoft.Extensions.Primitives.StringSegment.IsNullOrEmpty(Microsoft.Extensions.Primitives.StringSegment)">
  466. <summary>
  467. Indicates whether the specified <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> is null or an Empty string.
  468. </summary>
  469. <param name="value">The <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to test.</param>
  470. <returns></returns>
  471. </member>
  472. <member name="M:Microsoft.Extensions.Primitives.StringSegment.ToString">
  473. <summary>
  474. Returns the <see cref="T:System.String"/> represented by this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> or <code>String.Empty</code> if the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> does not contain a value.
  475. </summary>
  476. <returns>The <see cref="T:System.String"/> represented by this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> or <code>String.Empty</code> if the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> does not contain a value.</returns>
  477. </member>
  478. <member name="T:Microsoft.Extensions.Primitives.StringTokenizer">
  479. <summary>
  480. Tokenizes a <see cref="T:System.String"/> into <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>s.
  481. </summary>
  482. </member>
  483. <member name="M:Microsoft.Extensions.Primitives.StringTokenizer.#ctor(System.String,System.Char[])">
  484. <summary>
  485. Initializes a new instance of <see cref="T:Microsoft.Extensions.Primitives.StringTokenizer"/>.
  486. </summary>
  487. <param name="value">The <see cref="T:System.String"/> to tokenize.</param>
  488. <param name="separators">The characters to tokenize by.</param>
  489. </member>
  490. <member name="M:Microsoft.Extensions.Primitives.StringTokenizer.#ctor(Microsoft.Extensions.Primitives.StringSegment,System.Char[])">
  491. <summary>
  492. Initializes a new instance of <see cref="T:Microsoft.Extensions.Primitives.StringTokenizer"/>.
  493. </summary>
  494. <param name="value">The <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to tokenize.</param>
  495. <param name="separators">The characters to tokenize by.</param>
  496. </member>
  497. <member name="T:Microsoft.Extensions.Primitives.StringValues">
  498. <summary>
  499. Represents zero/null, one, or many strings in an efficient way.
  500. </summary>
  501. </member>
  502. <member name="P:Microsoft.Extensions.Primitives.Resources.Argument_InvalidOffsetLength">
  503. <summary>Offset and length are out of bounds for the string or length is greater than the number of characters from index to the end of the string.</summary>
  504. </member>
  505. <member name="P:Microsoft.Extensions.Primitives.Resources.Argument_InvalidOffsetLengthStringSegment">
  506. <summary>Offset and length are out of bounds for this StringSegment or length is greater than the number of characters to the end of this StringSegment.</summary>
  507. </member>
  508. <member name="P:Microsoft.Extensions.Primitives.Resources.Capacity_CannotChangeAfterWriteStarted">
  509. <summary>Cannot change capacity after write started.</summary>
  510. </member>
  511. <member name="P:Microsoft.Extensions.Primitives.Resources.Capacity_NotEnough">
  512. <summary>Not enough capacity to write '{0}' characters, only '{1}' left.</summary>
  513. </member>
  514. <member name="M:Microsoft.Extensions.Primitives.Resources.FormatCapacity_NotEnough(System.Object,System.Object)">
  515. <summary>Not enough capacity to write '{0}' characters, only '{1}' left.</summary>
  516. </member>
  517. <member name="P:Microsoft.Extensions.Primitives.Resources.Capacity_NotUsedEntirely">
  518. <summary>Entire reserved capacity was not used. Capacity: '{0}', written '{1}'.</summary>
  519. </member>
  520. <member name="M:Microsoft.Extensions.Primitives.Resources.FormatCapacity_NotUsedEntirely(System.Object,System.Object)">
  521. <summary>Entire reserved capacity was not used. Capacity: '{0}', written '{1}'.</summary>
  522. </member>
  523. </members>
  524. </doc>