System.Text.Json.xml 216 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>System.Text.Json</name>
  5. </assembly>
  6. <members>
  7. <member name="T:System.Text.Json.JsonCommentHandling">
  8. <summary>Defines how the <see cref="T:System.Text.Json.Utf8JsonReader" /> struct handles comments.</summary>
  9. </member>
  10. <member name="F:System.Text.Json.JsonCommentHandling.Allow">
  11. <summary>Allows comments within the JSON input and treats them as valid tokens. While reading, the caller can access the comment values.</summary>
  12. </member>
  13. <member name="F:System.Text.Json.JsonCommentHandling.Disallow">
  14. <summary>Doesn't allow comments within the JSON input. Comments are treated as invalid JSON if found, and a <see cref="T:System.Text.Json.JsonException" /> is thrown. This is the default value.</summary>
  15. </member>
  16. <member name="F:System.Text.Json.JsonCommentHandling.Skip">
  17. <summary>Allows comments within the JSON input and ignores them. The <see cref="T:System.Text.Json.Utf8JsonReader" /> behaves as if no comments are present.</summary>
  18. </member>
  19. <member name="T:System.Text.Json.JsonDocument">
  20. <summary>Provides a mechanism for examining the structural content of a JSON value without automatically instantiating data values.</summary>
  21. </member>
  22. <member name="M:System.Text.Json.JsonDocument.Dispose">
  23. <summary>Releases the resources used by this <see cref="T:System.Text.Json.JsonDocument" /> instance.</summary>
  24. </member>
  25. <member name="M:System.Text.Json.JsonDocument.Parse(System.Buffers.ReadOnlySequence{System.Byte},System.Text.Json.JsonDocumentOptions)">
  26. <summary>Parses a sequence as UTF-8-encoded text representing a single JSON byte value into a JsonDocument.</summary>
  27. <param name="utf8Json">The JSON text to parse.</param>
  28. <param name="options">Options to control the reader behavior during parsing.</param>
  29. <returns>A JsonDocument representation of the JSON value.</returns>
  30. <exception cref="T:System.Text.Json.JsonException">
  31. <paramref name="utf8Json" /> does not represent a valid single JSON value.</exception>
  32. <exception cref="T:System.ArgumentException">
  33. <paramref name="readerOptions" /> contains unsupported options.</exception>
  34. </member>
  35. <member name="M:System.Text.Json.JsonDocument.Parse(System.IO.Stream,System.Text.Json.JsonDocumentOptions)">
  36. <summary>Parses a <see cref="T:System.IO.Stream" /> as UTF-8-encoded data representing a single JSON value into a JsonDocument. The stream is read to completion.</summary>
  37. <param name="utf8Json">The JSON data to parse.</param>
  38. <param name="options">Options to control the reader behavior during parsing.</param>
  39. <returns>A JsonDocument representation of the JSON value.</returns>
  40. <exception cref="T:System.Text.Json.JsonException">
  41. <paramref name="utf8Json" /> does not represent a valid single JSON value.</exception>
  42. <exception cref="T:System.ArgumentException">
  43. <paramref name="readerOptions" /> contains unsupported options.</exception>
  44. </member>
  45. <member name="M:System.Text.Json.JsonDocument.Parse(System.ReadOnlyMemory{System.Byte},System.Text.Json.JsonDocumentOptions)">
  46. <summary>Parses memory as UTF-8-encoded text representing a single JSON byte value into a JsonDocument.</summary>
  47. <param name="utf8Json">The JSON text to parse.</param>
  48. <param name="options">Options to control the reader behavior during parsing.</param>
  49. <returns>A JsonDocument representation of the JSON value.</returns>
  50. <exception cref="T:System.Text.Json.JsonException">
  51. <paramref name="utf8Json" /> does not represent a valid single JSON value.</exception>
  52. <exception cref="T:System.ArgumentException">
  53. <paramref name="readerOptions" /> contains unsupported options.</exception>
  54. </member>
  55. <member name="M:System.Text.Json.JsonDocument.Parse(System.ReadOnlyMemory{System.Char},System.Text.Json.JsonDocumentOptions)">
  56. <summary>Parses text representing a single JSON character value into a JsonDocument.</summary>
  57. <param name="json">The JSON text to parse.</param>
  58. <param name="options">Options to control the reader behavior during parsing.</param>
  59. <returns>A JsonDocument representation of the JSON value.</returns>
  60. <exception cref="T:System.Text.Json.JsonException">
  61. <paramref name="json" /> does not represent a valid single JSON value.</exception>
  62. <exception cref="T:System.ArgumentException">
  63. <paramref name="readerOptions" /> contains unsupported options.</exception>
  64. </member>
  65. <member name="M:System.Text.Json.JsonDocument.Parse(System.String,System.Text.Json.JsonDocumentOptions)">
  66. <summary>Parses text representing a single JSON string value into a JsonDocument.</summary>
  67. <param name="json">The JSON text to parse.</param>
  68. <param name="options">Options to control the reader behavior during parsing.</param>
  69. <returns>A JsonDocument representation of the JSON value.</returns>
  70. <exception cref="T:System.Text.Json.JsonException">
  71. <paramref name="json" /> does not represent a valid single JSON value.</exception>
  72. <exception cref="T:System.ArgumentException">
  73. <paramref name="readerOptions" /> contains unsupported options.</exception>
  74. </member>
  75. <member name="M:System.Text.Json.JsonDocument.ParseAsync(System.IO.Stream,System.Text.Json.JsonDocumentOptions,System.Threading.CancellationToken)">
  76. <summary>Parses a <see cref="T:System.IO.Stream" /> as UTF-8-encoded data representing a single JSON value into a JsonDocument. The stream is read to completion.</summary>
  77. <param name="utf8Json">The JSON data to parse.</param>
  78. <param name="options">Options to control the reader behavior during parsing.</param>
  79. <param name="cancellationToken">The token to monitor for cancellation requests.</param>
  80. <returns>A task to produce a JsonDocument representation of the JSON value.</returns>
  81. <exception cref="T:System.Text.Json.JsonException">
  82. <paramref name="utf8Json" /> does not represent a valid single JSON value.</exception>
  83. <exception cref="T:System.ArgumentException">
  84. <paramref name="readerOptions" /> contains unsupported options.</exception>
  85. </member>
  86. <member name="M:System.Text.Json.JsonDocument.ParseValue(System.Text.Json.Utf8JsonReader@)">
  87. <summary>Parses one JSON value (including objects or arrays) from the provided reader.</summary>
  88. <param name="reader">The reader to read.</param>
  89. <returns>A JsonDocument representing the value (and nested values) read from the reader.</returns>
  90. <exception cref="T:System.ArgumentException">
  91. <paramref name="reader" /> contains unsupported options.
  92. -or-
  93. The current <paramref name="reader" /> token does not start or represent a value.</exception>
  94. <exception cref="T:System.Text.Json.JsonException">A value could not be read from the reader.</exception>
  95. </member>
  96. <member name="P:System.Text.Json.JsonDocument.RootElement">
  97. <summary>Gets the root element of this JSON document.</summary>
  98. <returns>A <see cref="T:System.Text.Json.JsonElement" /> representing the value of the document.</returns>
  99. </member>
  100. <member name="M:System.Text.Json.JsonDocument.TryParseValue(System.Text.Json.Utf8JsonReader@,System.Text.Json.JsonDocument@)">
  101. <summary>Attempts to parse one JSON value (including objects or arrays) from the provided reader.</summary>
  102. <param name="reader">The reader to read.</param>
  103. <param name="document">When the method returns, contains the parsed document.</param>
  104. <returns>
  105. <see langword="true" /> if a value was read and parsed into a JsonDocument; <see langword="false" /> if the reader ran out of data while parsing. All other situations result in an exception being thrown.</returns>
  106. <exception cref="T:System.ArgumentException">
  107. <paramref name="reader" /> contains unsupported options.
  108. -or-
  109. The current <paramref name="reader" /> token does not start or represent a value.</exception>
  110. <exception cref="T:System.Text.Json.JsonException">A value could not be read from the reader.</exception>
  111. </member>
  112. <member name="M:System.Text.Json.JsonDocument.WriteTo(System.Text.Json.Utf8JsonWriter)">
  113. <summary>Writes the document to the provided writer as a JSON value.</summary>
  114. <param name="writer">The writer to which to write the document.</param>
  115. <exception cref="T:System.ArgumentNullException">The <paramref name="writer" /> parameter is <see langword="null" />.</exception>
  116. <exception cref="T:System.InvalidOperationException">The <see cref="P:System.Text.Json.JsonElement.ValueKind" /> of this <see cref="P:System.Text.Json.JsonDocument.RootElement" /> would result in invalid JSON.</exception>
  117. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  118. </member>
  119. <member name="T:System.Text.Json.JsonDocumentOptions">
  120. <summary>Provides the ability for the user to define custom behavior when parsing JSON to create a <see cref="T:System.Text.Json.JsonDocument" />.</summary>
  121. </member>
  122. <member name="P:System.Text.Json.JsonDocumentOptions.AllowTrailingCommas">
  123. <summary>Gets or sets a value that indicates whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being read.</summary>
  124. <returns>
  125. <see langword="true" /> if an extra comma at the end of a list of JSON values in an object or array is allowed; otherwise, <see langword="false" />. Default is <see langword="false" /></returns>
  126. </member>
  127. <member name="P:System.Text.Json.JsonDocumentOptions.CommentHandling">
  128. <summary>Gets or sets a value that determines how the <see cref="T:System.Text.Json.JsonDocument" /> handles comments when reading through the JSON data.</summary>
  129. <returns>One of the enumeration values that indicates how comments are handled.</returns>
  130. <exception cref="T:System.ArgumentOutOfRangeException">The comment handling enum is set to a value that is not supported (or not within the <see cref="T:System.Text.Json.JsonCommentHandling" /> enum range).</exception>
  131. </member>
  132. <member name="P:System.Text.Json.JsonDocumentOptions.MaxDepth">
  133. <summary>Gets or sets the maximum depth allowed when parsing JSON data, with the default (that is, 0) indicating a maximum depth of 64.</summary>
  134. <returns>The maximum depth allowed when parsing JSON data.</returns>
  135. <exception cref="T:System.ArgumentOutOfRangeException">The max depth is set to a negative value.</exception>
  136. </member>
  137. <member name="T:System.Text.Json.JsonElement">
  138. <summary>Represents a specific JSON value within a <see cref="T:System.Text.Json.JsonDocument" />.</summary>
  139. </member>
  140. <member name="T:System.Text.Json.JsonElement.ArrayEnumerator">
  141. <summary>Represents an enumerator for the contents of a JSON array.</summary>
  142. </member>
  143. <member name="P:System.Text.Json.JsonElement.ArrayEnumerator.Current">
  144. <summary>Gets the element in the collection at the current position of the enumerator.</summary>
  145. <returns>The element in the collection at the current position of the enumerator.</returns>
  146. </member>
  147. <member name="M:System.Text.Json.JsonElement.ArrayEnumerator.Dispose">
  148. <summary>Releases the resources used by this <see cref="T:System.Text.Json.JsonElement.ArrayEnumerator" /> instance.</summary>
  149. </member>
  150. <member name="M:System.Text.Json.JsonElement.ArrayEnumerator.GetEnumerator">
  151. <summary>Returns an enumerator that iterates through a collection.</summary>
  152. <returns>An enumerator that can be used to iterate through the array.</returns>
  153. </member>
  154. <member name="M:System.Text.Json.JsonElement.ArrayEnumerator.MoveNext">
  155. <summary>Advances the enumerator to the next element of the collection.</summary>
  156. <returns>
  157. <see langword="true" /> if the enumerator was successfully advanced to the next element; <see langword="false" /> if the enumerator has passed the end of the collection.</returns>
  158. </member>
  159. <member name="M:System.Text.Json.JsonElement.ArrayEnumerator.Reset">
  160. <summary>Sets the enumerator to its initial position, which is before the first element in the collection.</summary>
  161. </member>
  162. <member name="M:System.Text.Json.JsonElement.ArrayEnumerator.System#Collections#Generic#IEnumerable{System#Text#Json#JsonElement}#GetEnumerator">
  163. <summary>Returns an enumerator that iterates through a collection.</summary>
  164. <returns>An enumerator for an array of <see cref="T:System.Text.Json.JsonElement" /> that can be used to iterate through the collection.</returns>
  165. </member>
  166. <member name="M:System.Text.Json.JsonElement.ArrayEnumerator.System#Collections#IEnumerable#GetEnumerator">
  167. <summary>Returns an enumerator that iterates through a collection.</summary>
  168. <returns>An enumerator that can be used to iterate through the collection.</returns>
  169. </member>
  170. <member name="P:System.Text.Json.JsonElement.ArrayEnumerator.System#Collections#IEnumerator#Current">
  171. <summary>Gets the element in the collection at the current position of the enumerator.</summary>
  172. <returns>The element in the collection at the current position of the enumerator.</returns>
  173. </member>
  174. <member name="M:System.Text.Json.JsonElement.Clone">
  175. <summary>Gets a JsonElement that can be safely stored beyond the lifetime of the original <see cref="T:System.Text.Json.JsonDocument" />.</summary>
  176. <returns>A JsonElement that can be safely stored beyond the lifetime of the original <see cref="T:System.Text.Json.JsonDocument" />.</returns>
  177. </member>
  178. <member name="M:System.Text.Json.JsonElement.EnumerateArray">
  179. <summary>Gets an enumerator to enumerate the values in the JSON array represented by this JsonElement.</summary>
  180. <returns>An enumerator to enumerate the values in the JSON array represented by this JsonElement.</returns>
  181. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Array" />.</exception>
  182. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  183. </member>
  184. <member name="M:System.Text.Json.JsonElement.EnumerateObject">
  185. <summary>Gets an enumerator to enumerate the properties in the JSON object represented by this JsonElement.</summary>
  186. <returns>An enumerator to enumerate the properties in the JSON object represented by this JsonElement.</returns>
  187. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Object" />.</exception>
  188. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  189. </member>
  190. <member name="M:System.Text.Json.JsonElement.GetArrayLength">
  191. <summary>Gets the number of values contained within the current array value.</summary>
  192. <returns>The number of values contained within the current array value.</returns>
  193. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Array" />.</exception>
  194. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  195. </member>
  196. <member name="M:System.Text.Json.JsonElement.GetBoolean">
  197. <summary>Gets the value of the element as a <see cref="T:System.Boolean" />.</summary>
  198. <returns>The value of the element as a <see cref="T:System.Boolean" />.</returns>
  199. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is neither <see cref="F:System.Text.Json.JsonValueKind.True" /> nor <see cref="F:System.Text.Json.JsonValueKind.False" />.</exception>
  200. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  201. </member>
  202. <member name="M:System.Text.Json.JsonElement.GetByte">
  203. <summary>Gets the current JSON number as a <see cref="T:System.Byte" />.</summary>
  204. <returns>The current JSON number as a <see cref="T:System.Byte" />.</returns>
  205. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  206. <exception cref="T:System.FormatException">The value cannot be represented as a <see cref="T:System.Byte" />.</exception>
  207. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  208. </member>
  209. <member name="M:System.Text.Json.JsonElement.GetBytesFromBase64">
  210. <summary>Gets the value of the element as a byte array.</summary>
  211. <returns>The value decoded as a byte array.</returns>
  212. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.String" />.</exception>
  213. <exception cref="T:System.FormatException">The value is not encoded as Base64 text and hence cannot be decoded to bytes.</exception>
  214. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  215. </member>
  216. <member name="M:System.Text.Json.JsonElement.GetDateTime">
  217. <summary>Gets the value of the element as a <see cref="T:System.DateTime" />.</summary>
  218. <returns>The value of the element as a <see cref="T:System.DateTime" />.</returns>
  219. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.String" />.</exception>
  220. <exception cref="T:System.FormatException">The value cannot be read as a <see cref="T:System.DateTime" />.</exception>
  221. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  222. </member>
  223. <member name="M:System.Text.Json.JsonElement.GetDateTimeOffset">
  224. <summary>Gets the value of the element as a <see cref="T:System.DateTimeOffset" />.</summary>
  225. <returns>The value of the element as a <see cref="T:System.DateTimeOffset" />.</returns>
  226. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.String" />.</exception>
  227. <exception cref="T:System.FormatException">The value cannot be read as a <see cref="T:System.DateTimeOffset" />.</exception>
  228. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  229. </member>
  230. <member name="M:System.Text.Json.JsonElement.GetDecimal">
  231. <summary>Gets the current JSON number as a <see cref="T:System.Decimal" />.</summary>
  232. <returns>The current JSON number as a <see cref="T:System.Decimal" />.</returns>
  233. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  234. <exception cref="T:System.FormatException">The value cannot be represented as a <see cref="T:System.Decimal" />.</exception>
  235. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  236. </member>
  237. <member name="M:System.Text.Json.JsonElement.GetDouble">
  238. <summary>Gets the current JSON number as a <see cref="T:System.Double" />.</summary>
  239. <returns>The current JSON number as a <see cref="T:System.Double" />.</returns>
  240. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  241. <exception cref="T:System.FormatException">The value cannot be represented as a <see cref="T:System.Double" />.</exception>
  242. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  243. </member>
  244. <member name="M:System.Text.Json.JsonElement.GetGuid">
  245. <summary>Gets the value of the element as a <see cref="T:System.Guid" />.</summary>
  246. <returns>The value of the element as a <see cref="T:System.Guid" />.</returns>
  247. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.String" />.</exception>
  248. <exception cref="T:System.FormatException">The value cannot be represented as a <see cref="T:System.Guid" />.</exception>
  249. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  250. </member>
  251. <member name="M:System.Text.Json.JsonElement.GetInt16">
  252. <summary>Gets the current JSON number as an <see cref="T:System.Int16" />.</summary>
  253. <returns>The current JSON number as an <see cref="T:System.Int16" />.</returns>
  254. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  255. <exception cref="T:System.FormatException">The value cannot be represented as an <see cref="T:System.Int16" />.</exception>
  256. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  257. </member>
  258. <member name="M:System.Text.Json.JsonElement.GetInt32">
  259. <summary>Gets the current JSON number as an <see cref="T:System.Int32" />.</summary>
  260. <returns>The current JSON number as an <see cref="T:System.Int32" />.</returns>
  261. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  262. <exception cref="T:System.FormatException">The value cannot be represented as an <see cref="T:System.Int32" />.</exception>
  263. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  264. </member>
  265. <member name="M:System.Text.Json.JsonElement.GetInt64">
  266. <summary>Gets the current JSON number as an <see cref="T:System.Int64" />.</summary>
  267. <returns>The current JSON number as an <see cref="T:System.Int64" />.</returns>
  268. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  269. <exception cref="T:System.FormatException">The value cannot be represented as a <see cref="T:System.Int64" />.</exception>
  270. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  271. </member>
  272. <member name="M:System.Text.Json.JsonElement.GetProperty(System.ReadOnlySpan{System.Byte})">
  273. <summary>Gets a <see cref="T:System.Text.Json.JsonElement" /> representing the value of a required property identified by <paramref name="utf8PropertyName" />.</summary>
  274. <param name="utf8PropertyName">The UTF-8 representation (with no Byte-Order-Mark (BOM)) of the name of the property to return.</param>
  275. <returns>A <see cref="T:System.Text.Json.JsonElement" /> representing the value of the requested property.</returns>
  276. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Object" />.</exception>
  277. <exception cref="T:System.Collections.Generic.KeyNotFoundException">No property was found with the requested name.</exception>
  278. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  279. </member>
  280. <member name="M:System.Text.Json.JsonElement.GetProperty(System.ReadOnlySpan{System.Char})">
  281. <summary>Gets a <see cref="T:System.Text.Json.JsonElement" /> representing the value of a required property identified by <paramref name="propertyName" />.</summary>
  282. <param name="propertyName">The name of the property whose value is to be returned.</param>
  283. <returns>A <see cref="T:System.Text.Json.JsonElement" /> representing the value of the requested property.</returns>
  284. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Object" />.</exception>
  285. <exception cref="T:System.Collections.Generic.KeyNotFoundException">No property was found with the requested name.</exception>
  286. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  287. </member>
  288. <member name="M:System.Text.Json.JsonElement.GetProperty(System.String)">
  289. <summary>Gets a <see cref="T:System.Text.Json.JsonElement" /> representing the value of a required property identified by <paramref name="propertyName" />.</summary>
  290. <param name="propertyName">The name of the property whose value is to be returned.</param>
  291. <returns>A <see cref="T:System.Text.Json.JsonElement" /> representing the value of the requested property.</returns>
  292. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Object" />.</exception>
  293. <exception cref="T:System.Collections.Generic.KeyNotFoundException">No property was found with the requested name.</exception>
  294. <exception cref="T:System.ArgumentNullException">
  295. <paramref name="propertyName" /> is <see langword="null" />.</exception>
  296. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  297. </member>
  298. <member name="M:System.Text.Json.JsonElement.GetRawText">
  299. <summary>Gets a string that represents the original input data backing this value.</summary>
  300. <returns>The original input data backing this value.</returns>
  301. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  302. </member>
  303. <member name="M:System.Text.Json.JsonElement.GetSByte">
  304. <summary>Gets the current JSON number as an <see cref="T:System.SByte" />.</summary>
  305. <returns>The current JSON number as an <see cref="T:System.SByte" />.</returns>
  306. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  307. <exception cref="T:System.FormatException">The value cannot be represented as an <see cref="T:System.SByte" />.</exception>
  308. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  309. </member>
  310. <member name="M:System.Text.Json.JsonElement.GetSingle">
  311. <summary>Gets the current JSON number as a <see cref="T:System.Single" />.</summary>
  312. <returns>The current JSON number as a <see cref="T:System.Single" />.</returns>
  313. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  314. <exception cref="T:System.FormatException">The value cannot be represented as a <see cref="T:System.Single" />.</exception>
  315. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  316. </member>
  317. <member name="M:System.Text.Json.JsonElement.GetString">
  318. <summary>Gets the value of the element as a <see cref="T:System.String" />.</summary>
  319. <returns>The value of the element as a <see cref="T:System.String" />.</returns>
  320. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is neither <see cref="F:System.Text.Json.JsonValueKind.String" /> nor <see cref="F:System.Text.Json.JsonValueKind.Null" />.</exception>
  321. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  322. </member>
  323. <member name="M:System.Text.Json.JsonElement.GetUInt16">
  324. <summary>Gets the current JSON number as a <see cref="T:System.UInt16" />.</summary>
  325. <returns>The current JSON number as a <see cref="T:System.UInt16" />.</returns>
  326. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  327. <exception cref="T:System.FormatException">The value cannot be represented as a <see cref="T:System.UInt16" />.</exception>
  328. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  329. </member>
  330. <member name="M:System.Text.Json.JsonElement.GetUInt32">
  331. <summary>Gets the current JSON number as a <see cref="T:System.UInt32" />.</summary>
  332. <returns>The current JSON number as a <see cref="T:System.UInt32" />.</returns>
  333. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  334. <exception cref="T:System.FormatException">The value cannot be represented as a <see cref="T:System.UInt32" />.</exception>
  335. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  336. </member>
  337. <member name="M:System.Text.Json.JsonElement.GetUInt64">
  338. <summary>Gets the current JSON number as a <see cref="T:System.UInt64" />.</summary>
  339. <returns>The current JSON number as a <see cref="T:System.UInt64" />.</returns>
  340. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  341. <exception cref="T:System.FormatException">The value cannot be represented as a <see cref="T:System.UInt64" />.</exception>
  342. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  343. </member>
  344. <member name="P:System.Text.Json.JsonElement.Item(System.Int32)">
  345. <summary>Gets the value at the specified index if the current value is an <see cref="F:System.Text.Json.JsonValueKind.Array" />.</summary>
  346. <param name="index">The item index.</param>
  347. <returns>The value at the specified index.</returns>
  348. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Array" />.</exception>
  349. <exception cref="T:System.IndexOutOfRangeException">
  350. <paramref name="index" /> is not in the range [0, <see cref="M:System.Text.Json.JsonElement.GetArrayLength" />()).</exception>
  351. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  352. </member>
  353. <member name="T:System.Text.Json.JsonElement.ObjectEnumerator">
  354. <summary>Represents an enumerator for the properties of a JSON object.</summary>
  355. </member>
  356. <member name="P:System.Text.Json.JsonElement.ObjectEnumerator.Current">
  357. <summary>Gets the element in the collection at the current position of the enumerator.</summary>
  358. <returns>The element in the collection at the current position of the enumerator.</returns>
  359. </member>
  360. <member name="M:System.Text.Json.JsonElement.ObjectEnumerator.Dispose">
  361. <summary>Releases the resources used by this <see cref="T:System.Text.Json.JsonElement.ObjectEnumerator" /> instance.</summary>
  362. </member>
  363. <member name="M:System.Text.Json.JsonElement.ObjectEnumerator.GetEnumerator">
  364. <summary>Returns an enumerator that iterates the properties of an object.</summary>
  365. <returns>An enumerator that can be used to iterate through the object.</returns>
  366. </member>
  367. <member name="M:System.Text.Json.JsonElement.ObjectEnumerator.MoveNext">
  368. <summary>Advances the enumerator to the next element of the collection.</summary>
  369. <returns>
  370. <see langword="true" /> if the enumerator was successfully advanced to the next element; <see langword="false" /> if the enumerator has passed the end of the collection.</returns>
  371. </member>
  372. <member name="M:System.Text.Json.JsonElement.ObjectEnumerator.Reset">
  373. <summary>Sets the enumerator to its initial position, which is before the first element in the collection.</summary>
  374. </member>
  375. <member name="M:System.Text.Json.JsonElement.ObjectEnumerator.System#Collections#Generic#IEnumerable{System#Text#Json#JsonProperty}#GetEnumerator">
  376. <summary>Returns an enumerator that iterates through a collection.</summary>
  377. <returns>An enumerator for <see cref="T:System.Text.Json.JsonProperty" /> objects that can be used to iterate through the collection.</returns>
  378. </member>
  379. <member name="M:System.Text.Json.JsonElement.ObjectEnumerator.System#Collections#IEnumerable#GetEnumerator">
  380. <summary>Returns an enumerator that iterates through a collection.</summary>
  381. <returns>An enumerator that can be used to iterate through the collection.</returns>
  382. </member>
  383. <member name="P:System.Text.Json.JsonElement.ObjectEnumerator.System#Collections#IEnumerator#Current">
  384. <summary>Gets the element in the collection at the current position of the enumerator.</summary>
  385. <returns>The element in the collection at the current position of the enumerator.</returns>
  386. </member>
  387. <member name="M:System.Text.Json.JsonElement.ToString">
  388. <summary>Gets a string representation for the current value appropriate to the value type.</summary>
  389. <returns>A string representation for the current value appropriate to the value type.</returns>
  390. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  391. </member>
  392. <member name="M:System.Text.Json.JsonElement.TryGetByte(System.Byte@)">
  393. <summary>Attempts to represent the current JSON number as a <see cref="T:System.Byte" />.</summary>
  394. <param name="value">When the method returns, contains the byte equivalent of the current JSON number if the conversion succeeded.</param>
  395. <returns>
  396. <see langword="true" /> if the number can be represented as a <see cref="T:System.Byte" />; otherwise, <see langword="false" />.</returns>
  397. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  398. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  399. </member>
  400. <member name="M:System.Text.Json.JsonElement.TryGetBytesFromBase64(System.Byte[]@)">
  401. <summary>Attempts to represent the current JSON string as a byte array, assuming that it is Base64 encoded.</summary>
  402. <param name="value">If the method succeeds, contains the decoded binary representation of the Base64 text.</param>
  403. <returns>
  404. <see langword="true" /> if the entire token value is encoded as valid Base64 text and can be successfully decoded to bytes; otherwise, <see langword="false" />.</returns>
  405. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.String" />.</exception>
  406. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  407. </member>
  408. <member name="M:System.Text.Json.JsonElement.TryGetDateTime(System.DateTime@)">
  409. <summary>Attempts to represent the current JSON string as a <see cref="T:System.DateTime" />.</summary>
  410. <param name="value">When this method returns, contains the date and time value equivalent to the current JSON string.</param>
  411. <returns>
  412. <see langword="true" /> if the string can be represented as a <see cref="T:System.DateTime" />; otherwise, <see langword="false" />.</returns>
  413. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.String" />.</exception>
  414. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  415. </member>
  416. <member name="M:System.Text.Json.JsonElement.TryGetDateTimeOffset(System.DateTimeOffset@)">
  417. <summary>Attempts to represent the current JSON string as a <see cref="T:System.DateTimeOffset" />.</summary>
  418. <param name="value">When this method returns, contains the date and time equivalent to the current JSON string.</param>
  419. <returns>
  420. <see langword="true" /> if the string can be represented as a <see cref="T:System.DateTimeOffset" />; otherwise, <see langword="false" />.</returns>
  421. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.String" />.</exception>
  422. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  423. </member>
  424. <member name="M:System.Text.Json.JsonElement.TryGetDecimal(System.Decimal@)">
  425. <summary>Attempts to represent the current JSON number as a <see cref="T:System.Decimal" />.</summary>
  426. <param name="value">When this method returns, contains the decimal equivalent of the current JSON number.</param>
  427. <returns>
  428. <see langword="true" /> if the number can be represented as a <see cref="T:System.Decimal" />; otherwise, <see langword="false" />.</returns>
  429. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  430. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  431. </member>
  432. <member name="M:System.Text.Json.JsonElement.TryGetDouble(System.Double@)">
  433. <summary>Attempts to represent the current JSON number as a <see cref="T:System.Double" />.</summary>
  434. <param name="value">When this method returns, contains a double-precision floating point value equivalent to the current JSON number.</param>
  435. <returns>
  436. <see langword="true" /> if the number can be represented as a <see cref="T:System.Double" />; otherwise, <see langword="false" />.</returns>
  437. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  438. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  439. </member>
  440. <member name="M:System.Text.Json.JsonElement.TryGetGuid(System.Guid@)">
  441. <summary>Attempts to represent the current JSON string as a <see cref="T:System.Guid" />.</summary>
  442. <param name="value">When this method returns, contains the GUID equivalent to the current JSON string.</param>
  443. <returns>
  444. <see langword="true" /> if the string can be represented as a <see cref="T:System.Guid" />; otherwise, <see langword="false" />.</returns>
  445. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.String" />.</exception>
  446. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  447. </member>
  448. <member name="M:System.Text.Json.JsonElement.TryGetInt16(System.Int16@)">
  449. <summary>Attempts to represent the current JSON number as an <see cref="T:System.Int16" />.</summary>
  450. <param name="value">When the method returns, contains the 16-bit integer equivalent of the current JSON number if the conversion succeeded.</param>
  451. <returns>
  452. <see langword="true" /> if the number can be represented as an <see cref="T:System.Int16" />; otherwise, <see langword="false" />.</returns>
  453. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  454. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  455. </member>
  456. <member name="M:System.Text.Json.JsonElement.TryGetInt32(System.Int32@)">
  457. <summary>Attempts to represent the current JSON number as an <see cref="T:System.Int32" />.</summary>
  458. <param name="value">When this method returns, contains the 32-biut integer value equivalent to the current JSON number.</param>
  459. <returns>
  460. <see langword="true" /> if the number can be represented as an <see cref="T:System.Int32" />; otherwise, <see langword="false" />.</returns>
  461. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  462. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  463. </member>
  464. <member name="M:System.Text.Json.JsonElement.TryGetInt64(System.Int64@)">
  465. <summary>Attempts to represent the current JSON number as a <see cref="T:System.Int64" />.</summary>
  466. <param name="value">When this method returns, contains the 64-bit integer value equivalent to the current JSON number.</param>
  467. <returns>
  468. <see langword="true" /> if the number can be represented as a <see cref="T:System.Int64" />; otherwise, <see langword="false" />.</returns>
  469. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  470. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  471. </member>
  472. <member name="M:System.Text.Json.JsonElement.TryGetProperty(System.ReadOnlySpan{System.Byte},System.Text.Json.JsonElement@)">
  473. <summary>Looks for a property named <paramref name="utf8PropertyName" /> in the current object, returning a value that indicates whether or not such a property exists. When the property exists, the method assigns its value to the <paramref name="value" /> argument.</summary>
  474. <param name="utf8PropertyName">The UTF-8 (with no Byte-Order-Mark (BOM)) representation of the name of the property to return.</param>
  475. <param name="value">Receives the value of the located property.</param>
  476. <returns>
  477. <see langword="true" /> if the property was found; otherwise, <see langword="false" />.</returns>
  478. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Object" />.</exception>
  479. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  480. </member>
  481. <member name="M:System.Text.Json.JsonElement.TryGetProperty(System.ReadOnlySpan{System.Char},System.Text.Json.JsonElement@)">
  482. <summary>Looks for a property named <paramref name="propertyName" /> in the current object, returning a value that indicates whether or not such a property exists. When the property exists, the method assigns its value to the <paramref name="value" /> argument.</summary>
  483. <param name="propertyName">The name of the property to find.</param>
  484. <param name="value">When this method returns, contains the value of the specified property.</param>
  485. <returns>
  486. <see langword="true" /> if the property was found; otherwise, <see langword="false" />.</returns>
  487. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Object" />.</exception>
  488. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  489. </member>
  490. <member name="M:System.Text.Json.JsonElement.TryGetProperty(System.String,System.Text.Json.JsonElement@)">
  491. <summary>Looks for a property named <paramref name="propertyName" /> in the current object, returning a value that indicates whether or not such a property exists. When the property exists, its value is assigned to the <paramref name="value" /> argument.</summary>
  492. <param name="propertyName">The name of the property to find.</param>
  493. <param name="value">When this method returns, contains the value of the specified property.</param>
  494. <returns>
  495. <see langword="true" /> if the property was found; otherwise, <see langword="false" />.</returns>
  496. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Object" />.</exception>
  497. <exception cref="T:System.ArgumentNullException">
  498. <paramref name="propertyName" /> is <see langword="null" />.</exception>
  499. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  500. </member>
  501. <member name="M:System.Text.Json.JsonElement.TryGetSByte(System.SByte@)">
  502. <summary>Attempts to represent the current JSON number as an <see cref="T:System.SByte" />.</summary>
  503. <param name="value">When the method returns, contains the signed byte equivalent of the current JSON number if the conversion succeeded.</param>
  504. <returns>
  505. <see langword="true" /> if the number can be represented as an <see cref="T:System.SByte" />; otherwise, <see langword="false" />.</returns>
  506. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  507. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  508. </member>
  509. <member name="M:System.Text.Json.JsonElement.TryGetSingle(System.Single@)">
  510. <summary>Attempts to represent the current JSON number as a <see cref="T:System.Single" />.</summary>
  511. <param name="value">When this method returns, contains the single-precision floating point value equivalent to the current JSON number.</param>
  512. <returns>
  513. <see langword="true" /> if the number can be represented as a <see cref="T:System.Single" />; otherwise, <see langword="false" />.</returns>
  514. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  515. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  516. </member>
  517. <member name="M:System.Text.Json.JsonElement.TryGetUInt16(System.UInt16@)">
  518. <summary>Attempts to represent the current JSON number as a <see cref="T:System.UInt16" />.</summary>
  519. <param name="value">When the method returns, contains the unsigned 16-bit integer equivalent of the current JSON number if the conversion succeeded.</param>
  520. <returns>
  521. <see langword="true" /> if the number can be represented as a <see cref="T:System.UInt16" />; otherwise, <see langword="false" />.</returns>
  522. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  523. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  524. </member>
  525. <member name="M:System.Text.Json.JsonElement.TryGetUInt32(System.UInt32@)">
  526. <summary>Attempts to represent the current JSON number as a <see cref="T:System.UInt32" />.</summary>
  527. <param name="value">When this method returns, contains unsigned 32-bit integer value equivalent to the current JSON number.</param>
  528. <returns>
  529. <see langword="true" /> if the number can be represented as a <see cref="T:System.UInt32" />; otherwise, <see langword="false" />.</returns>
  530. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  531. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  532. </member>
  533. <member name="M:System.Text.Json.JsonElement.TryGetUInt64(System.UInt64@)">
  534. <summary>Attempts to represent the current JSON number as a <see cref="T:System.UInt64" />.</summary>
  535. <param name="value">When this method returns, contains unsigned 64-bit integer value equivalent to the current JSON number.</param>
  536. <returns>
  537. <see langword="true" /> if the number can be represented as a <see cref="T:System.UInt64" />; otherwise, <see langword="false" />.</returns>
  538. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.Number" />.</exception>
  539. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  540. </member>
  541. <member name="M:System.Text.Json.JsonElement.ValueEquals(System.ReadOnlySpan{System.Byte})">
  542. <summary>Compares the text represented by a UTF8-encoded byte span to the string value of this element.</summary>
  543. <param name="utf8Text">The UTF-8 encoded text to compare against.</param>
  544. <returns>
  545. <see langword="true" /> if the string value of this element has the same UTF-8 encoding as
  546. <paramref name="utf8Text" />; otherwise, <see langword="false" />.</returns>
  547. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.String" />.</exception>
  548. </member>
  549. <member name="M:System.Text.Json.JsonElement.ValueEquals(System.ReadOnlySpan{System.Char})">
  550. <summary>Compares a specified read-only character span to the string value of this element.</summary>
  551. <param name="text">The text to compare against.</param>
  552. <returns>
  553. <see langword="true" /> if the string value of this element matches <paramref name="text" />; otherwise, <see langword="false" />.</returns>
  554. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.String" />.</exception>
  555. </member>
  556. <member name="M:System.Text.Json.JsonElement.ValueEquals(System.String)">
  557. <summary>Compares a specified string to the string value of this element.</summary>
  558. <param name="text">The text to compare against.</param>
  559. <returns>
  560. <see langword="true" /> if the string value of this element matches <paramref name="text" />; otherwise, <see langword="false" />.</returns>
  561. <exception cref="T:System.InvalidOperationException">This value's <see cref="P:System.Text.Json.JsonElement.ValueKind" /> is not <see cref="F:System.Text.Json.JsonValueKind.String" />.</exception>
  562. </member>
  563. <member name="P:System.Text.Json.JsonElement.ValueKind">
  564. <summary>Gets the type of the current JSON value.</summary>
  565. <returns>The type of the current JSON value.</returns>
  566. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  567. </member>
  568. <member name="M:System.Text.Json.JsonElement.WriteTo(System.Text.Json.Utf8JsonWriter)">
  569. <summary>Writes the element to the specified writer as a JSON value.</summary>
  570. <param name="writer">The writer to which to write the element.</param>
  571. <exception cref="T:System.ArgumentNullException">The <paramref name="writer" /> parameter is <see langword="null" />.</exception>
  572. <exception cref="T:System.InvalidOperationException">The <see cref="P:System.Text.Json.JsonElement.ValueKind" /> of this value is <see cref="F:System.Text.Json.JsonValueKind.Undefined" />.</exception>
  573. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  574. </member>
  575. <member name="T:System.Text.Json.JsonEncodedText">
  576. <summary>Provides methods to transform UTF-8 or UTF-16 encoded text into a form that is suitable for JSON.</summary>
  577. </member>
  578. <member name="M:System.Text.Json.JsonEncodedText.Encode(System.ReadOnlySpan{System.Byte},System.Text.Encodings.Web.JavaScriptEncoder)">
  579. <summary>Encodes a UTF-8 text value as a JSON string.</summary>
  580. <param name="utf8Value">The UTF-8 encoded text to convert to JSON encoded text.</param>
  581. <param name="encoder">The encoder to use when escaping the string, or <see langword="null" /> to use the default encoder.</param>
  582. <returns>The encoded JSON text.</returns>
  583. <exception cref="T:System.ArgumentException">
  584. <paramref name="utf8Value" /> is too large.
  585. -or-
  586. <paramref name="utf8Value" /> contains invalid UTF-8 bytes.</exception>
  587. </member>
  588. <member name="M:System.Text.Json.JsonEncodedText.Encode(System.ReadOnlySpan{System.Char},System.Text.Encodings.Web.JavaScriptEncoder)">
  589. <summary>Encodes a specified text value as a JSON string.</summary>
  590. <param name="value">The value to convert to JSON encoded text.</param>
  591. <param name="encoder">The encoder to use when escaping the string, or <see langword="null" /> to use the default encoder.</param>
  592. <returns>The encoded JSON text.</returns>
  593. <exception cref="T:System.ArgumentException">
  594. <paramref name="value" /> is too large.
  595. -or-
  596. <paramref name="value" /> contains invalid UTF-16 characters.</exception>
  597. </member>
  598. <member name="M:System.Text.Json.JsonEncodedText.Encode(System.String,System.Text.Encodings.Web.JavaScriptEncoder)">
  599. <summary>Encodes the string text value as a JSON string.</summary>
  600. <param name="value">The value to convert to JSON encoded text.</param>
  601. <param name="encoder">The encoder to use when escaping the string, or <see langword="null" /> to use the default encoder.</param>
  602. <returns>The encoded JSON text.</returns>
  603. <exception cref="T:System.ArgumentNullException">
  604. <paramref name="value" /> is <see langword="null" />.</exception>
  605. <exception cref="T:System.ArgumentException">
  606. <paramref name="value" /> is too large.
  607. -or-
  608. <paramref name="value" /> contains invalid UTF-16 characters.</exception>
  609. </member>
  610. <member name="P:System.Text.Json.JsonEncodedText.EncodedUtf8Bytes">
  611. <summary>Gets the UTF-8 encoded representation of the pre-encoded JSON text.</summary>
  612. <returns>The UTF-8 encoded representation of the pre-encoded JSON text.</returns>
  613. </member>
  614. <member name="M:System.Text.Json.JsonEncodedText.Equals(System.Object)">
  615. <summary>Determines whether this instance and a specified object, which must also be a <see cref="T:System.Text.Json.JsonEncodedText" /> instance, have the same value.</summary>
  616. <param name="obj">The object to compare to this instance.</param>
  617. <returns>
  618. <see langword="true" /> if the current instance and <paramref name="obj" /> are equal; otherwise, <see langword="false" />.</returns>
  619. </member>
  620. <member name="M:System.Text.Json.JsonEncodedText.Equals(System.Text.Json.JsonEncodedText)">
  621. <summary>Determines whether this instance and another specified <see cref="T:System.Text.Json.JsonEncodedText" /> instance have the same value.</summary>
  622. <param name="other">The object to compare to this instance.</param>
  623. <returns>
  624. <see langword="true" /> if this instance and <paramref name="other" /> have the same value; otherwise, <see langword="false" />.</returns>
  625. </member>
  626. <member name="M:System.Text.Json.JsonEncodedText.GetHashCode">
  627. <summary>Returns the hash code for this <see cref="T:System.Text.Json.JsonEncodedText" />.</summary>
  628. <returns>The hash code for this instance.</returns>
  629. </member>
  630. <member name="M:System.Text.Json.JsonEncodedText.ToString">
  631. <summary>Converts the value of this instance to a <see cref="T:System.String" />.</summary>
  632. <returns>The underlying UTF-16 encoded string.</returns>
  633. </member>
  634. <member name="T:System.Text.Json.JsonException">
  635. <summary>Defines a custom exception object that is thrown when invalid JSON text is encountered, when the defined maximum depth is passed, or the JSON text is not compatible with the type of a property on an object.</summary>
  636. </member>
  637. <member name="M:System.Text.Json.JsonException.#ctor">
  638. <summary>Initializes a new instance of the <see cref="T:System.Text.Json.JsonException" /> class.</summary>
  639. </member>
  640. <member name="M:System.Text.Json.JsonException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  641. <summary>Creates a new exception object with serialized data.</summary>
  642. <param name="info">The serialized object data about the exception being thrown.</param>
  643. <param name="context">An object that contains contextual information about the source or destination.</param>
  644. <exception cref="T:System.ArgumentNullException">
  645. <paramref name="info" /> is <see langword="null" />.</exception>
  646. </member>
  647. <member name="M:System.Text.Json.JsonException.#ctor(System.String)">
  648. <summary>Initializes a new instance of the <see cref="T:System.Text.Json.JsonException" /> class with a specified error message.</summary>
  649. <param name="message">The context-specific error message.</param>
  650. </member>
  651. <member name="M:System.Text.Json.JsonException.#ctor(System.String,System.Exception)">
  652. <summary>Initializes a new instance of the <see cref="T:System.Text.Json.JsonException" /> class, with a specified error message and a reference to the inner exception that is the cause of this exception.</summary>
  653. <param name="message">The context-specific error message.</param>
  654. <param name="innerException">The exception that caused the current exception.</param>
  655. </member>
  656. <member name="M:System.Text.Json.JsonException.#ctor(System.String,System.String,System.Nullable{System.Int64},System.Nullable{System.Int64})">
  657. <summary>Creates a new exception object to relay error information to the user.</summary>
  658. <param name="message">The context-specific error message.</param>
  659. <param name="path">The path where the invalid JSON was encountered.</param>
  660. <param name="lineNumber">The line number (starting at 0) at which the invalid JSON was encountered when deserializing.</param>
  661. <param name="bytePositionInLine">The byte count within the current line (starting at 0) where the invalid JSON was encountered.</param>
  662. </member>
  663. <member name="M:System.Text.Json.JsonException.#ctor(System.String,System.String,System.Nullable{System.Int64},System.Nullable{System.Int64},System.Exception)">
  664. <summary>Creates a new exception object to relay error information to the user that includes a specified inner exception.</summary>
  665. <param name="message">The context-specific error message.</param>
  666. <param name="path">The path where the invalid JSON was encountered.</param>
  667. <param name="lineNumber">The line number (starting at 0) at which the invalid JSON was encountered when deserializing.</param>
  668. <param name="bytePositionInLine">The byte count (starting at 0) within the current line where the invalid JSON was encountered.</param>
  669. <param name="innerException">The exception that caused the current exception.</param>
  670. </member>
  671. <member name="P:System.Text.Json.JsonException.BytePositionInLine">
  672. <summary>Gets the zero-based number of bytes read within the current line before the exception.</summary>
  673. <returns>The zero-based number of bytes read within the current line before the exception.</returns>
  674. </member>
  675. <member name="M:System.Text.Json.JsonException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  676. <summary>Sets the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with information about the exception.</summary>
  677. <param name="info">The serialized object data about the exception being thrown.</param>
  678. <param name="context">An object that contains contextual information about the source or destination.</param>
  679. </member>
  680. <member name="P:System.Text.Json.JsonException.LineNumber">
  681. <summary>Gets the zero-based number of lines read before the exception.</summary>
  682. <returns>The zero-based number of lines read before the exception.</returns>
  683. </member>
  684. <member name="P:System.Text.Json.JsonException.Message">
  685. <summary>Gets a message that describes the current exception.</summary>
  686. <returns>The error message that describes the current exception.</returns>
  687. </member>
  688. <member name="P:System.Text.Json.JsonException.Path">
  689. <summary>Gets The path within the JSON where the exception was encountered.</summary>
  690. <returns>The path within the JSON where the exception was encountered.</returns>
  691. </member>
  692. <member name="T:System.Text.Json.JsonNamingPolicy">
  693. <summary>Determines the naming policy used to convert a string-based name to another format, such as a camel-casing format.</summary>
  694. </member>
  695. <member name="M:System.Text.Json.JsonNamingPolicy.#ctor">
  696. <summary>Initializes a new instance of <see cref="T:System.Text.Json.JsonNamingPolicy" />.</summary>
  697. </member>
  698. <member name="P:System.Text.Json.JsonNamingPolicy.CamelCase">
  699. <summary>Gets the naming policy for camel-casing.</summary>
  700. <returns>The naming policy for camel-casing.</returns>
  701. </member>
  702. <member name="M:System.Text.Json.JsonNamingPolicy.ConvertName(System.String)">
  703. <summary>When overridden in a derived class, converts the specified name according to the policy.</summary>
  704. <param name="name">The name to convert.</param>
  705. <returns>The converted name.</returns>
  706. </member>
  707. <member name="T:System.Text.Json.JsonProperty">
  708. <summary>Represents a single property for a JSON object.</summary>
  709. </member>
  710. <member name="P:System.Text.Json.JsonProperty.Name">
  711. <summary>Gets the name of this property.</summary>
  712. <returns>The name of this property.</returns>
  713. </member>
  714. <member name="M:System.Text.Json.JsonProperty.NameEquals(System.ReadOnlySpan{System.Byte})">
  715. <summary>Compares the specified UTF-8 encoded text to the name of this property.</summary>
  716. <param name="utf8Text">The UTF-8 encoded text to compare against.</param>
  717. <returns>
  718. <see langword="true" /> if the name of this property has the same UTF-8 encoding as <paramref name="utf8Text" />; otherwise, <see langword="false" />.</returns>
  719. <exception cref="T:System.InvalidOperationException">This value's <see cref="T:System.Type" /> is not <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />.</exception>
  720. </member>
  721. <member name="M:System.Text.Json.JsonProperty.NameEquals(System.ReadOnlySpan{System.Char})">
  722. <summary>Compares the specified text as a character span to the name of this property.</summary>
  723. <param name="text">The text to compare against.</param>
  724. <returns>
  725. <see langword="true" /> if the name of this property matches <paramref name="text" />; otherwise, <see langword="false" />.</returns>
  726. <exception cref="T:System.InvalidOperationException">This value's <see cref="T:System.Type" /> is not <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />.</exception>
  727. </member>
  728. <member name="M:System.Text.Json.JsonProperty.NameEquals(System.String)">
  729. <summary>Compares the specified string to the name of this property.</summary>
  730. <param name="text">The text to compare against.</param>
  731. <returns>
  732. <see langword="true" /> if the name of this property matches <paramref name="text" />; otherwise <see langword="false" />.</returns>
  733. <exception cref="T:System.InvalidOperationException">This value's <see cref="T:System.Type" /> is not <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />.</exception>
  734. </member>
  735. <member name="M:System.Text.Json.JsonProperty.ToString">
  736. <summary>Provides a string representation of the property for debugging purposes.</summary>
  737. <returns>A string containing the uninterpreted value of the property, beginning at the declaring open-quote and ending at the last character that is part of the value.</returns>
  738. </member>
  739. <member name="P:System.Text.Json.JsonProperty.Value">
  740. <summary>Gets the value of this property.</summary>
  741. <returns>The value of this property.</returns>
  742. </member>
  743. <member name="M:System.Text.Json.JsonProperty.WriteTo(System.Text.Json.Utf8JsonWriter)">
  744. <summary>Writes the property to the provided writer as a named JSON object property.</summary>
  745. <param name="writer">The writer to which to write the property.</param>
  746. <exception cref="T:System.ArgumentNullException">
  747. <paramref name="writer" /> is <see langword="null" />.</exception>
  748. <exception cref="T:System.ArgumentException">
  749. <see cref="P:System.Text.Json.JsonProperty.Name" /> is too large to be a JSON object property.</exception>
  750. <exception cref="T:System.InvalidOperationException">The <see cref="P:System.Text.Json.JsonElement.ValueKind" /> of this JSON property's <see cref="P:System.Text.Json.JsonProperty.Value" /> would result in invalid JSON.</exception>
  751. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  752. </member>
  753. <member name="T:System.Text.Json.JsonReaderOptions">
  754. <summary>Provides the ability for the user to define custom behavior when reading JSON.</summary>
  755. </member>
  756. <member name="P:System.Text.Json.JsonReaderOptions.AllowTrailingCommas">
  757. <summary>Gets or sets a value that defines whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being read.</summary>
  758. <returns>
  759. <see langword="true" /> if an exra comma is allowed; otherwise, <see langword="false" />.</returns>
  760. </member>
  761. <member name="P:System.Text.Json.JsonReaderOptions.CommentHandling">
  762. <summary>Gets or sets a value that determines how the <see cref="T:System.Text.Json.Utf8JsonReader" /> handles comments when reading through the JSON data.</summary>
  763. <returns>One of the enumeration values that indicates how comments are handled.</returns>
  764. <exception cref="T:System.ArgumentOutOfRangeException">The property is being set to a value that is not a member of the <see cref="T:System.Text.Json.JsonCommentHandling" /> enumeration.</exception>
  765. </member>
  766. <member name="P:System.Text.Json.JsonReaderOptions.MaxDepth">
  767. <summary>Gets or sets the maximum depth allowed when reading JSON, with the default (that is, 0) indicating a maximum depth of 64.</summary>
  768. <returns>The maximum depth allowed when reading JSON.</returns>
  769. <exception cref="T:System.ArgumentOutOfRangeException">The maximum depth is being set to a negative value.</exception>
  770. </member>
  771. <member name="T:System.Text.Json.JsonReaderState">
  772. <summary>Defines an opaque type that holds and saves all the relevant state information, which must be provided to the <see cref="T:System.Text.Json.Utf8JsonReader" /> to continue reading after processing incomplete data.</summary>
  773. </member>
  774. <member name="M:System.Text.Json.JsonReaderState.#ctor(System.Text.Json.JsonReaderOptions)">
  775. <summary>Constructs a new <see cref="T:System.Text.Json.JsonReaderState" /> instance.</summary>
  776. <param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonReader" /> that is different from the JSON RFC (for example how to handle comments, or the maximum depth allowed when reading). By default, the <see cref="T:System.Text.Json.Utf8JsonReader" /> follows the JSON RFC strictly (comments within the JSON are invalid) and reads up to a maximum depth of 64.</param>
  777. <exception cref="T:System.ArgumentException">The maximum depth is set to a non-positive value (&lt; 0).</exception>
  778. </member>
  779. <member name="P:System.Text.Json.JsonReaderState.Options">
  780. <summary>Gets the custom behavior to use when reading JSON data using the <see cref="T:System.Text.Json.Utf8JsonReader" /> struct that may deviate from strict adherence to the JSON specification, which is the default behavior.</summary>
  781. <returns>The custom behavior to use when reading JSON data.</returns>
  782. </member>
  783. <member name="T:System.Text.Json.JsonSerializer">
  784. <summary>Provides functionality to serialize objects or value types to JSON and to deserialize JSON into objects or value types.</summary>
  785. </member>
  786. <member name="M:System.Text.Json.JsonSerializer.Deserialize(System.ReadOnlySpan{System.Byte},System.Type,System.Text.Json.JsonSerializerOptions)">
  787. <summary>Parses the UTF-8 encoded text representing a single JSON value into an instance of a specified type.</summary>
  788. <param name="utf8Json">The JSON text to parse.</param>
  789. <param name="returnType">The type of the object to convert to and return.</param>
  790. <param name="options">Options to control the behavior during parsing.</param>
  791. <returns>A <paramref name="returnType" /> representation of the JSON value.</returns>
  792. <exception cref="T:System.ArgumentNullException">
  793. <paramref name="returnType" /> is <see langword="null" />.</exception>
  794. <exception cref="T:System.Text.Json.JsonException">The JSON is invalid.
  795. -or-
  796. <typeparamref name="returnType" /> is not compatible with the JSON.
  797. -or-
  798. There is remaining data in the span beyond a single JSON value.</exception>
  799. </member>
  800. <member name="M:System.Text.Json.JsonSerializer.Deserialize(System.String,System.Type,System.Text.Json.JsonSerializerOptions)">
  801. <summary>Parses the text representing a single JSON value into an instance of a specified type.</summary>
  802. <param name="json">The JSON text to parse.</param>
  803. <param name="returnType">The type of the object to convert to and return.</param>
  804. <param name="options">Options to control the behavior during parsing.</param>
  805. <returns>A <paramref name="returnType" /> representation of the JSON value.</returns>
  806. <exception cref="T:System.ArgumentNullException">
  807. <paramref name="json" /> or <paramref name="returnType" /> is <see langword="null" />.</exception>
  808. <exception cref="T:System.Text.Json.JsonException">The JSON is invalid.
  809. -or-
  810. <typeparamref name="TValue" /> is not compatible with the JSON.
  811. -or-
  812. There is remaining data in the string beyond a single JSON value.</exception>
  813. </member>
  814. <member name="M:System.Text.Json.JsonSerializer.Deserialize(System.Text.Json.Utf8JsonReader@,System.Type,System.Text.Json.JsonSerializerOptions)">
  815. <summary>Reads one JSON value (including objects or arrays) from the provided reader and converts it into an instance of a specified type.</summary>
  816. <param name="reader">The reader to read the JSON from.</param>
  817. <param name="returnType">The type of the object to convert to and return.</param>
  818. <param name="options">Options to control the serializer behavior during reading.</param>
  819. <returns>A <paramref name="returnType" /> representation of the JSON value.</returns>
  820. <exception cref="T:System.ArgumentNullException">
  821. <paramref name="returnType" /> is <see langword="null" />.</exception>
  822. <exception cref="T:System.Text.Json.JsonException">The JSON is invalid.
  823. -or-
  824. <typeparamref name="returnType" /> is not compatible with the JSON.
  825. -or-
  826. A value could not be read from the reader.</exception>
  827. <exception cref="T:System.ArgumentException">
  828. <paramref name="reader" /> is using unsupported options.</exception>
  829. </member>
  830. <member name="M:System.Text.Json.JsonSerializer.Deserialize``1(System.ReadOnlySpan{System.Byte},System.Text.Json.JsonSerializerOptions)">
  831. <summary>Parses the UTF-8 encoded text representing a single JSON value into an instance of the type specified by a generic type parameter.</summary>
  832. <param name="utf8Json">The JSON text to parse.</param>
  833. <param name="options">Options to control the behavior during parsing.</param>
  834. <typeparam name="TValue">The target type of the UTF-8 encoded text.</typeparam>
  835. <returns>A <typeparamref name="TValue" /> representation of the JSON value.</returns>
  836. <exception cref="T:System.Text.Json.JsonException">The JSON is invalid.
  837. -or-
  838. <typeparamref name="TValue" /> is not compatible with the JSON.
  839. -or-
  840. There is remaining data in the span beyond a single JSON value.</exception>
  841. </member>
  842. <member name="M:System.Text.Json.JsonSerializer.Deserialize``1(System.String,System.Text.Json.JsonSerializerOptions)">
  843. <summary>Parses the text representing a single JSON value into an instance of the type specified by a generic type parameter.</summary>
  844. <param name="json">The JSON text to parse.</param>
  845. <param name="options">Options to control the behavior during parsing.</param>
  846. <typeparam name="TValue">The target type of the JSON value.</typeparam>
  847. <returns>A <typeparamref name="TValue" /> representation of the JSON value.</returns>
  848. <exception cref="T:System.ArgumentNullException">
  849. <paramref name="json" /> is <see langword="null" />.</exception>
  850. <exception cref="T:System.Text.Json.JsonException">The JSON is invalid.
  851. -or-
  852. <typeparamref name="TValue" /> is not compatible with the JSON.
  853. -or-
  854. There is remaining data in the string beyond a single JSON value.</exception>
  855. </member>
  856. <member name="M:System.Text.Json.JsonSerializer.Deserialize``1(System.Text.Json.Utf8JsonReader@,System.Text.Json.JsonSerializerOptions)">
  857. <summary>Reads one JSON value (including objects or arrays) from the provided reader into an instance of the type specified by a generic type parameter.</summary>
  858. <param name="reader">The reader to read the JSON from.</param>
  859. <param name="options">Options to control serializer behavior during reading.</param>
  860. <typeparam name="TValue">The target type of the JSON value.</typeparam>
  861. <returns>A <typeparamref name="TValue" /> representation of the JSON value.</returns>
  862. <exception cref="T:System.Text.Json.JsonException">The JSON is invalid.
  863. -or-
  864. <typeparamref name="TValue" /> is not compatible with the JSON.
  865. -or-
  866. A value could not be read from the reader.</exception>
  867. <exception cref="T:System.ArgumentException">
  868. <paramref name="reader" /> uses unsupported options.</exception>
  869. </member>
  870. <member name="M:System.Text.Json.JsonSerializer.DeserializeAsync(System.IO.Stream,System.Type,System.Text.Json.JsonSerializerOptions,System.Threading.CancellationToken)">
  871. <summary>Asynchronously reads the UTF-8 encoded text representing a single JSON value into an instance of a specified type. The stream will be read to completion.</summary>
  872. <param name="utf8Json">The JSON data to parse.</param>
  873. <param name="returnType">The type of the object to convert to and return.</param>
  874. <param name="options">Options to control the behavior during reading.</param>
  875. <param name="cancellationToken">A cancellation token that may be used to cancel the read operation.</param>
  876. <returns>A <paramref name="returnType" /> representation of the JSON value.</returns>
  877. <exception cref="T:System.ArgumentNullException">
  878. <paramref name="utf8Json" /> or <paramref name="returnType" /> is <see langword="null" />.</exception>
  879. <exception cref="T:System.Text.Json.JsonException">The JSON is invalid.
  880. -or-
  881. <typeparamref name="TValue" /> is not compatible with the JSON.
  882. -or-
  883. There is remaining data in the stream.</exception>
  884. </member>
  885. <member name="M:System.Text.Json.JsonSerializer.DeserializeAsync``1(System.IO.Stream,System.Text.Json.JsonSerializerOptions,System.Threading.CancellationToken)">
  886. <summary>Asynchronously reads the UTF-8 encoded text representing a single JSON value into an instance of a type specified by a generic type parameter. The stream will be read to completion.</summary>
  887. <param name="utf8Json">The JSON data to parse.</param>
  888. <param name="options">Options to control the behavior during reading.</param>
  889. <param name="cancellationToken">A token that may be used to cancel the read operation.</param>
  890. <typeparam name="TValue">The target type of the JSON value.</typeparam>
  891. <returns>A <typeparamref name="TValue" /> representation of the JSON value.</returns>
  892. <exception cref="T:System.Text.Json.JsonException">The JSON is invalid.
  893. -or-
  894. <typeparamref name="TValue" /> is not compatible with the JSON.
  895. -or-
  896. There is remaining data in the stream.</exception>
  897. </member>
  898. <member name="M:System.Text.Json.JsonSerializer.Serialize(System.Object,System.Type,System.Text.Json.JsonSerializerOptions)">
  899. <summary>Converts the value of a specified type into a JSON string.</summary>
  900. <param name="value">The value to convert.</param>
  901. <param name="inputType">The type of the <paramref name="value" /> to convert.</param>
  902. <param name="options">Options to control the conversion behavior.</param>
  903. <returns>The JSON string representation of the value.</returns>
  904. </member>
  905. <member name="M:System.Text.Json.JsonSerializer.Serialize(System.Text.Json.Utf8JsonWriter,System.Object,System.Type,System.Text.Json.JsonSerializerOptions)">
  906. <summary>Writes the JSON representation of the specified type to the provided writer.</summary>
  907. <param name="writer">The JSON writer to write to.</param>
  908. <param name="value">The value to convert and write.</param>
  909. <param name="inputType">The type of the <paramref name="value" /> to convert.</param>
  910. <param name="options">Options to control serialization behavior.</param>
  911. </member>
  912. <member name="M:System.Text.Json.JsonSerializer.Serialize``1(``0,System.Text.Json.JsonSerializerOptions)">
  913. <summary>Converts the value of a type specified by a generic type parameter into a JSON string.</summary>
  914. <param name="value">The value to convert.</param>
  915. <param name="options">Options to control serialization behavior.</param>
  916. <typeparam name="TValue">The type of the value to serialize.</typeparam>
  917. <returns>A JSON string representation of the value.</returns>
  918. </member>
  919. <member name="M:System.Text.Json.JsonSerializer.Serialize``1(System.Text.Json.Utf8JsonWriter,``0,System.Text.Json.JsonSerializerOptions)">
  920. <summary>Writes the JSON representation of a type specified by a generic type parameter to the provided writer.</summary>
  921. <param name="writer">A JSON writer to write to.</param>
  922. <param name="value">The value to convert and write.</param>
  923. <param name="options">Options to control serialization behavior.</param>
  924. <typeparam name="TValue">The type of the value to serialize.</typeparam>
  925. </member>
  926. <member name="M:System.Text.Json.JsonSerializer.SerializeAsync(System.IO.Stream,System.Object,System.Type,System.Text.Json.JsonSerializerOptions,System.Threading.CancellationToken)">
  927. <summary>Asynchronously converts the value of a specified type to UTF-8 encoded JSON text and writes it to the specified stream.</summary>
  928. <param name="utf8Json">The UTF-8 stream to write to.</param>
  929. <param name="value">The value to convert.</param>
  930. <param name="inputType">The type of the <paramref name="value" /> to convert.</param>
  931. <param name="options">Options to control serialization behavior.</param>
  932. <param name="cancellationToken">A token that may be used to cancel the write operation.</param>
  933. <returns>A task that represents the asynchronous write operation.</returns>
  934. </member>
  935. <member name="M:System.Text.Json.JsonSerializer.SerializeAsync``1(System.IO.Stream,``0,System.Text.Json.JsonSerializerOptions,System.Threading.CancellationToken)">
  936. <summary>Asynchronously converts a value of a type specified by a generic type parameter to UTF-8 encoded JSON text and writes it to a stream.</summary>
  937. <param name="utf8Json">The UTF-8 stream to write to.</param>
  938. <param name="value">The value to convert.</param>
  939. <param name="options">Options to control serialization behavior.</param>
  940. <param name="cancellationToken">A token that may be used to cancel the write operation.</param>
  941. <typeparam name="TValue">The type of the value to serialize.</typeparam>
  942. <returns>A task that represents the asynchronous write operation.</returns>
  943. </member>
  944. <member name="M:System.Text.Json.JsonSerializer.SerializeToUtf8Bytes(System.Object,System.Type,System.Text.Json.JsonSerializerOptions)">
  945. <summary>Converts a value of the specified type into a JSON string, encoded as UTF-8 bytes.</summary>
  946. <param name="value">The value to convert.</param>
  947. <param name="inputType">The type of the <paramref name="value" /> to convert.</param>
  948. <param name="options">Options to control the conversion behavior.</param>
  949. <returns>A JSON string representation of the value, encoded as UTF-8 bytes.</returns>
  950. </member>
  951. <member name="M:System.Text.Json.JsonSerializer.SerializeToUtf8Bytes``1(``0,System.Text.Json.JsonSerializerOptions)">
  952. <summary>Converts the value of a type specified by a generic type parameter into a JSON string, encoded as UTF-8 bytes.</summary>
  953. <param name="value">The value to convert.</param>
  954. <param name="options">Options to control the conversion behavior.</param>
  955. <typeparam name="TValue">The type of the value.</typeparam>
  956. <returns>A JSON string representation of the value, encoded as UTF-8 bytes.</returns>
  957. </member>
  958. <member name="T:System.Text.Json.JsonSerializerOptions">
  959. <summary>Provides options to be used with <see cref="T:System.Text.Json.JsonSerializer" />.</summary>
  960. </member>
  961. <member name="M:System.Text.Json.JsonSerializerOptions.#ctor">
  962. <summary>Initializes a new instance of the <see cref="T:System.Text.Json.JsonSerializerOptions" /> class.</summary>
  963. </member>
  964. <member name="P:System.Text.Json.JsonSerializerOptions.AllowTrailingCommas">
  965. <summary>Get or sets a value that indicates whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being deserialized.</summary>
  966. <returns>
  967. <see langword="true" /> if an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored); <see langword="false" /> otherwise.</returns>
  968. <exception cref="T:System.InvalidOperationException">This property was set after serialization or deserialization has occurred.</exception>
  969. </member>
  970. <member name="P:System.Text.Json.JsonSerializerOptions.Converters">
  971. <summary>Gets the list of user-defined converters that were registered.</summary>
  972. <returns>The list of custom converters.</returns>
  973. </member>
  974. <member name="P:System.Text.Json.JsonSerializerOptions.DefaultBufferSize">
  975. <summary>Gets or sets the default buffer size, in bytes, to use when creating temporary buffers.</summary>
  976. <returns>The default buffer size in bytes.</returns>
  977. <exception cref="T:System.ArgumentException">The buffer size is less than 1.</exception>
  978. <exception cref="T:System.InvalidOperationException">This property was set after serialization or deserialization has occurred.</exception>
  979. </member>
  980. <member name="P:System.Text.Json.JsonSerializerOptions.DictionaryKeyPolicy">
  981. <summary>Gets or sets the policy used to convert a <see cref="T:System.Collections.IDictionary" /> key's name to another format, such as camel-casing.</summary>
  982. <returns>The policy used to convert a <see cref="T:System.Collections.IDictionary" /> key's name to another format.</returns>
  983. </member>
  984. <member name="P:System.Text.Json.JsonSerializerOptions.Encoder">
  985. <summary>Gets or sets the encoder to use when escaping strings, or <see langword="null" /> to use the default encoder.</summary>
  986. <returns>The JavaScript character encoding.</returns>
  987. </member>
  988. <member name="M:System.Text.Json.JsonSerializerOptions.GetConverter(System.Type)">
  989. <summary>Returns the converter for the specified type.</summary>
  990. <param name="typeToConvert">The type to return a converter for.</param>
  991. <returns>The first converter that supports the given type, or <see langword="null" /> if there is no converter.</returns>
  992. </member>
  993. <member name="P:System.Text.Json.JsonSerializerOptions.IgnoreNullValues">
  994. <summary>Gets or sets a value that determines whether <see langword="null" /> values are ignored during serialization and deserialization. The default value is <see langword="false" />.</summary>
  995. <returns>
  996. <see langword="true" /> to ignore null values during serialization and deserialization; otherwise, see langword="false" /&gt;.</returns>
  997. <exception cref="T:System.InvalidOperationException">This property was set after serialization or deserialization has occurred.</exception>
  998. </member>
  999. <member name="P:System.Text.Json.JsonSerializerOptions.IgnoreReadOnlyProperties">
  1000. <summary>Gets a value that determines whether read-only properties are ignored during serialization. The default value is <see langword="false" />.</summary>
  1001. <returns>
  1002. <see langword="true" /> to ignore read-only properties during serialization; otherwise, <see langword="false" />.</returns>
  1003. <exception cref="T:System.InvalidOperationException">This property was set after serialization or deserialization has occurred.</exception>
  1004. </member>
  1005. <member name="P:System.Text.Json.JsonSerializerOptions.MaxDepth">
  1006. <summary>Gets or sets the maximum depth allowed when serializing or deserializing JSON, with the default value of 0 indicating a maximum depth of 64.</summary>
  1007. <returns>The maximum depth allowed when serializing or deserializing JSON.</returns>
  1008. <exception cref="T:System.InvalidOperationException">This property was set after serialization or deserialization has occurred.</exception>
  1009. <exception cref="T:System.ArgumentOutOfRangeException">The max depth is set to a negative value.</exception>
  1010. </member>
  1011. <member name="P:System.Text.Json.JsonSerializerOptions.PropertyNameCaseInsensitive">
  1012. <summary>Gets or sets a value that determines whether a property's name uses a case-insensitive comparison during deserialization. The default value is <see langword="false" />.</summary>
  1013. <returns>
  1014. <see langword="true" /> to compare property names using case-insensitive comparison; otherwise, <see langword="false" />.</returns>
  1015. </member>
  1016. <member name="P:System.Text.Json.JsonSerializerOptions.PropertyNamingPolicy">
  1017. <summary>Gets or sets a value that specifies the policy used to convert a property's name on an object to another format, such as camel-casing, or <see langword="null" /> to leave property names unchanged.</summary>
  1018. <returns>A property naming policy, or <see langword="null" /> to leave property names unchanged.</returns>
  1019. </member>
  1020. <member name="P:System.Text.Json.JsonSerializerOptions.ReadCommentHandling">
  1021. <summary>Gets or sets a value that defines how comments are handled during deserialization.</summary>
  1022. <returns>A value that indicates whether comments are allowed, disallowed, or skipped.</returns>
  1023. <exception cref="T:System.InvalidOperationException">This property was set after serialization or deserialization has occurred.</exception>
  1024. <exception cref="T:System.ArgumentOutOfRangeException">The comment handling enum is set to a value that is not supported (or not within the <see cref="T:System.Text.Json.JsonCommentHandling" /> enum range).</exception>
  1025. </member>
  1026. <member name="P:System.Text.Json.JsonSerializerOptions.WriteIndented">
  1027. <summary>Gets or sets a value that defines whether JSON should use pretty printing. By default, JSON is serialized without any extra white space.</summary>
  1028. <returns>
  1029. <see langword="true" /> if JSON should pretty print on serialization; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
  1030. <exception cref="T:System.InvalidOperationException">This property was set after serialization or deserialization has occurred.</exception>
  1031. </member>
  1032. <member name="T:System.Text.Json.JsonTokenType">
  1033. <summary>Defines the various JSON tokens that make up a JSON text.</summary>
  1034. </member>
  1035. <member name="F:System.Text.Json.JsonTokenType.Comment">
  1036. <summary>The token type is a comment string.</summary>
  1037. </member>
  1038. <member name="F:System.Text.Json.JsonTokenType.EndArray">
  1039. <summary>The token type is the end of a JSON array.</summary>
  1040. </member>
  1041. <member name="F:System.Text.Json.JsonTokenType.EndObject">
  1042. <summary>The token type is the end of a JSON object.</summary>
  1043. </member>
  1044. <member name="F:System.Text.Json.JsonTokenType.False">
  1045. <summary>The token type is the JSON literal false.</summary>
  1046. </member>
  1047. <member name="F:System.Text.Json.JsonTokenType.None">
  1048. <summary>There is no value (as distinct from <see cref="F:System.Text.Json.JsonTokenType.Null" />).</summary>
  1049. </member>
  1050. <member name="F:System.Text.Json.JsonTokenType.Null">
  1051. <summary>The token type is the JSON literal null.</summary>
  1052. </member>
  1053. <member name="F:System.Text.Json.JsonTokenType.Number">
  1054. <summary>The token type is a JSON number.</summary>
  1055. </member>
  1056. <member name="F:System.Text.Json.JsonTokenType.PropertyName">
  1057. <summary>The token type is a JSON property name.</summary>
  1058. </member>
  1059. <member name="F:System.Text.Json.JsonTokenType.StartArray">
  1060. <summary>The token type is the start of a JSON array.</summary>
  1061. </member>
  1062. <member name="F:System.Text.Json.JsonTokenType.StartObject">
  1063. <summary>The token type is the start of a JSON object.</summary>
  1064. </member>
  1065. <member name="F:System.Text.Json.JsonTokenType.String">
  1066. <summary>The token type is a JSON string.</summary>
  1067. </member>
  1068. <member name="F:System.Text.Json.JsonTokenType.True">
  1069. <summary>The token type is the JSON literal true.</summary>
  1070. </member>
  1071. <member name="T:System.Text.Json.JsonValueKind">
  1072. <summary>Specifies the data type of a JSON value.</summary>
  1073. </member>
  1074. <member name="F:System.Text.Json.JsonValueKind.Array">
  1075. <summary>A JSON array.</summary>
  1076. </member>
  1077. <member name="F:System.Text.Json.JsonValueKind.False">
  1078. <summary>The JSON value false.</summary>
  1079. </member>
  1080. <member name="F:System.Text.Json.JsonValueKind.Null">
  1081. <summary>The JSON value null.</summary>
  1082. </member>
  1083. <member name="F:System.Text.Json.JsonValueKind.Number">
  1084. <summary>A JSON number.</summary>
  1085. </member>
  1086. <member name="F:System.Text.Json.JsonValueKind.Object">
  1087. <summary>A JSON object.</summary>
  1088. </member>
  1089. <member name="F:System.Text.Json.JsonValueKind.String">
  1090. <summary>A JSON string.</summary>
  1091. </member>
  1092. <member name="F:System.Text.Json.JsonValueKind.True">
  1093. <summary>The JSON value true.</summary>
  1094. </member>
  1095. <member name="F:System.Text.Json.JsonValueKind.Undefined">
  1096. <summary>There is no value (as distinct from <see cref="F:System.Text.Json.JsonValueKind.Null" />).</summary>
  1097. </member>
  1098. <member name="T:System.Text.Json.JsonWriterOptions">
  1099. <summary>Allows the user to define custom behavior when writing JSON using the <see cref="T:System.Text.Json.Utf8JsonWriter" />.</summary>
  1100. </member>
  1101. <member name="P:System.Text.Json.JsonWriterOptions.Encoder">
  1102. <summary>Gets or sets the encoder to use when escaping strings, or <see langword="null" /> to use the default encoder.</summary>
  1103. <returns>The JavaScript character encoder used to override the escaping behavior.</returns>
  1104. </member>
  1105. <member name="P:System.Text.Json.JsonWriterOptions.Indented">
  1106. <summary>Gets or sets a value that indicates whether the <see cref="T:System.Text.Json.Utf8JsonWriter" /> should format the JSON output, which includes indenting nested JSON tokens, adding new lines, and adding white space between property names and values.</summary>
  1107. <returns>
  1108. <see langword="true" /> to format the JSON output; <see langword="false" /> to write without any extra white space. The default is <see langword="false" />.</returns>
  1109. </member>
  1110. <member name="P:System.Text.Json.JsonWriterOptions.SkipValidation">
  1111. <summary>Gets or sets a value that indicates whether the <see cref="T:System.Text.Json.Utf8JsonWriter" /> should skip structural validation and allow the user to write invalid JSON.</summary>
  1112. <returns>
  1113. <see langword="true" /> to skip structural validation and allow invalid JSON; <see langword="false" /> to throw an <see cref="T:System.InvalidOperationException" /> on any attempt to write invalid JSON.</returns>
  1114. </member>
  1115. <member name="T:System.Text.Json.Serialization.JsonAttribute">
  1116. <summary>Provides the base class for serialization attributes.</summary>
  1117. </member>
  1118. <member name="M:System.Text.Json.Serialization.JsonAttribute.#ctor">
  1119. <summary>Creates a new instance of the <see cref="T:System.Text.Json.Serialization.JsonAttribute" />.</summary>
  1120. </member>
  1121. <member name="T:System.Text.Json.Serialization.JsonConverter">
  1122. <summary>Converts an object or value to or from JSON.</summary>
  1123. </member>
  1124. <member name="M:System.Text.Json.Serialization.JsonConverter.CanConvert(System.Type)">
  1125. <summary>When overridden in a derived class, determines whether the converter instance can convert the specified object type.</summary>
  1126. <param name="typeToConvert">The type of the object to check whether it can be converted by this converter instance.</param>
  1127. <returns>
  1128. <see langword="true" /> if the instance can convert the specified object type; otherwise, <see langword="false" />.</returns>
  1129. </member>
  1130. <member name="T:System.Text.Json.Serialization.JsonConverter`1">
  1131. <summary>Converts an object or value to or from JSON.</summary>
  1132. <typeparam name="T">The type of object or value handled by the converter.</typeparam>
  1133. </member>
  1134. <member name="M:System.Text.Json.Serialization.JsonConverter`1.#ctor">
  1135. <summary>Initializes a new <see cref="T:System.Text.Json.Serialization.JsonConverter`1" /> instance.</summary>
  1136. </member>
  1137. <member name="M:System.Text.Json.Serialization.JsonConverter`1.CanConvert(System.Type)">
  1138. <summary>Determines whether the specified type can be converted.</summary>
  1139. <param name="typeToConvert">The type to compare against.</param>
  1140. <returns>
  1141. <see langword="true" /> if the type can be converted; otherwise, <see langword="false" />.</returns>
  1142. </member>
  1143. <member name="M:System.Text.Json.Serialization.JsonConverter`1.Read(System.Text.Json.Utf8JsonReader@,System.Type,System.Text.Json.JsonSerializerOptions)">
  1144. <summary>Reads and converts the JSON to type <typeparamref name="T" />.</summary>
  1145. <param name="reader">The reader.</param>
  1146. <param name="typeToConvert">The type to convert.</param>
  1147. <param name="options">An object that specifies serialization options to use.</param>
  1148. <returns>The converted value.</returns>
  1149. </member>
  1150. <member name="M:System.Text.Json.Serialization.JsonConverter`1.Write(System.Text.Json.Utf8JsonWriter,`0,System.Text.Json.JsonSerializerOptions)">
  1151. <summary>Writes a specified value as JSON.</summary>
  1152. <param name="writer">The writer to write to.</param>
  1153. <param name="value">The value to convert to JSON.</param>
  1154. <param name="options">An object that specifies serialization options to use.</param>
  1155. </member>
  1156. <member name="T:System.Text.Json.Serialization.JsonConverterAttribute">
  1157. <summary>When placed on a property or type, specifies the converter type to use.</summary>
  1158. </member>
  1159. <member name="M:System.Text.Json.Serialization.JsonConverterAttribute.#ctor">
  1160. <summary>Initializes a new instance of <see cref="T:System.Text.Json.Serialization.JsonConverterAttribute" />.</summary>
  1161. </member>
  1162. <member name="M:System.Text.Json.Serialization.JsonConverterAttribute.#ctor(System.Type)">
  1163. <summary>Initializes a new instance of <see cref="T:System.Text.Json.Serialization.JsonConverterAttribute" /> with the specified converter type.</summary>
  1164. <param name="converterType">The type of the converter.</param>
  1165. </member>
  1166. <member name="P:System.Text.Json.Serialization.JsonConverterAttribute.ConverterType">
  1167. <summary>Gets the type of the <see cref="T:System.Text.Json.Serialization.JsonConverterAttribute" />, or <see langword="null" /> if it was created without a type.</summary>
  1168. <returns>The type of the <see cref="T:System.Text.Json.Serialization.JsonConverterAttribute" />, or <see langword="null" /> if it was created without a type.</returns>
  1169. </member>
  1170. <member name="M:System.Text.Json.Serialization.JsonConverterAttribute.CreateConverter(System.Type)">
  1171. <summary>When overridden in a derived class and <see cref="P:System.Text.Json.Serialization.JsonConverterAttribute.ConverterType" /> is <see langword="null" />, allows the derived class to create a <see cref="T:System.Text.Json.Serialization.JsonConverter" /> in order to pass additional state.</summary>
  1172. <param name="typeToConvert">The type of the converter.</param>
  1173. <returns>The custom converter.</returns>
  1174. </member>
  1175. <member name="T:System.Text.Json.Serialization.JsonConverterFactory">
  1176. <summary>Supports converting several types by using a factory pattern.</summary>
  1177. </member>
  1178. <member name="M:System.Text.Json.Serialization.JsonConverterFactory.#ctor">
  1179. <summary>When overidden in a derived class, initializes a new instance of the <see cref="T:System.Text.Json.Serialization.JsonConverterFactory" /> class.</summary>
  1180. </member>
  1181. <member name="M:System.Text.Json.Serialization.JsonConverterFactory.CreateConverter(System.Type,System.Text.Json.JsonSerializerOptions)">
  1182. <summary>Creates a converter for a specified type.</summary>
  1183. <param name="typeToConvert">The type handled by the converter.</param>
  1184. <param name="options">The serialization options to use.</param>
  1185. <returns>A converter for which <typeparamref name="T" /> is compatible with <paramref name="typeToConvert" />.</returns>
  1186. </member>
  1187. <member name="T:System.Text.Json.Serialization.JsonExtensionDataAttribute">
  1188. <summary>When placed on a property of type <see cref="T:System.Collections.Generic.IDictionary`2" />, any properties that do not have a matching member are added to that dictionary during deserialization and written during serialization.</summary>
  1189. </member>
  1190. <member name="M:System.Text.Json.Serialization.JsonExtensionDataAttribute.#ctor">
  1191. <summary>Instantiates a new instance of the <see cref="T:System.Text.Json.Serialization.JsonExtensionDataAttribute" /> class.</summary>
  1192. </member>
  1193. <member name="T:System.Text.Json.Serialization.JsonIgnoreAttribute">
  1194. <summary>Prevents a property from being serialized or deserialized.</summary>
  1195. </member>
  1196. <member name="M:System.Text.Json.Serialization.JsonIgnoreAttribute.#ctor">
  1197. <summary>Initializes a new instance of <see cref="T:System.Text.Json.Serialization.JsonIgnoreAttribute" />.</summary>
  1198. </member>
  1199. <member name="T:System.Text.Json.Serialization.JsonPropertyNameAttribute">
  1200. <summary>Specifies the property name that is present in the JSON when serializing and deserializing. This overrides any naming policy specified by <see cref="T:System.Text.Json.JsonNamingPolicy" />.</summary>
  1201. </member>
  1202. <member name="M:System.Text.Json.Serialization.JsonPropertyNameAttribute.#ctor(System.String)">
  1203. <summary>Initializes a new instance of <see cref="T:System.Text.Json.Serialization.JsonPropertyNameAttribute" /> with the specified property name.</summary>
  1204. <param name="name">The name of the property.</param>
  1205. </member>
  1206. <member name="P:System.Text.Json.Serialization.JsonPropertyNameAttribute.Name">
  1207. <summary>Gets the name of the property.</summary>
  1208. <returns>The name of the property.</returns>
  1209. </member>
  1210. <member name="T:System.Text.Json.Serialization.JsonStringEnumConverter">
  1211. <summary>Converts enumeration values to and from strings.</summary>
  1212. </member>
  1213. <member name="M:System.Text.Json.Serialization.JsonStringEnumConverter.#ctor">
  1214. <summary>Initializes an instance of the <see cref="T:System.Text.Json.Serialization.JsonStringEnumConverter" /> class with the default naming policy that allows integer values.</summary>
  1215. </member>
  1216. <member name="M:System.Text.Json.Serialization.JsonStringEnumConverter.#ctor(System.Text.Json.JsonNamingPolicy,System.Boolean)">
  1217. <summary>Initializes an instance of the <see cref="T:System.Text.Json.Serialization.JsonStringEnumConverter" /> class with a specified naming policy and a value that indicates whether undefined enumeration values are allowed.</summary>
  1218. <param name="namingPolicy">The optional naming policy for writing enum values.</param>
  1219. <param name="allowIntegerValues">
  1220. <see langword="true" /> to allow undefined enum values; otherwise, <see langword="false" />. When <see langword="true" />, if an enum value isn't defined, it will output as a number rather than a string.</param>
  1221. </member>
  1222. <member name="M:System.Text.Json.Serialization.JsonStringEnumConverter.CanConvert(System.Type)">
  1223. <summary>Determines whether the specified type can be converted to an enum.</summary>
  1224. <param name="typeToConvert">The type to be checked.</param>
  1225. <returns>
  1226. <see langword="true" /> if the type can be converted; otherwise, <see langword="false" />.</returns>
  1227. </member>
  1228. <member name="M:System.Text.Json.Serialization.JsonStringEnumConverter.CreateConverter(System.Type,System.Text.Json.JsonSerializerOptions)">
  1229. <summary>Creates a converter for the specified type.</summary>
  1230. <param name="typeToConvert">The type handled by the converter.</param>
  1231. <param name="options">The serialization options to use.</param>
  1232. <returns>A converter for which <typeparamref name="T" /> is compatible with <paramref name="typeToConvert" />.</returns>
  1233. </member>
  1234. <member name="T:System.Text.Json.Utf8JsonReader">
  1235. <summary>Provides a high-performance API for forward-only, read-only access to UTF-8 encoded JSON text.</summary>
  1236. </member>
  1237. <member name="M:System.Text.Json.Utf8JsonReader.#ctor(System.Buffers.ReadOnlySequence{System.Byte},System.Boolean,System.Text.Json.JsonReaderState)">
  1238. <summary>Initializes a new instance of the <see cref="T:System.Text.Json.Utf8JsonReader" /> structure that processes a read-only sequence of UTF-8 encoded text and indicates whether the input contains all the text to process.</summary>
  1239. <param name="jsonData">The UTF-8 encoded JSON text to process.</param>
  1240. <param name="isFinalBlock">
  1241. <see langword="true" /> to indicate that the input sequence contains the entire data to process; <see langword="false" /> to indicate that the input span contains partial data with more data to follow.</param>
  1242. <param name="state">An object that contains the reader state. If this is the first call to the constructor, pass the default state; otherwise, pass the value of the <see cref="P:System.Text.Json.Utf8JsonReader.CurrentState" /> property from the previous instance of the <see cref="T:System.Text.Json.Utf8JsonReader" />.</param>
  1243. </member>
  1244. <member name="M:System.Text.Json.Utf8JsonReader.#ctor(System.Buffers.ReadOnlySequence{System.Byte},System.Text.Json.JsonReaderOptions)">
  1245. <summary>Initializes a new instance of the <see cref="T:System.Text.Json.Utf8JsonReader" /> structure that processes a read-only sequence of UTF-8 encoded text using the specified options.</summary>
  1246. <param name="jsonData">The UTF-8 encoded JSON text to process.</param>
  1247. <param name="options">Defines customized behavior of the <see cref="T:System.Text.Json.Utf8JsonReader" /> that differs from the JSON RFC (for example how to handle comments or maximum depth allowed when reading). By default, the <see cref="T:System.Text.Json.Utf8JsonReader" /> follows the JSON RFC strictly; comments within the JSON are invalid, and the maximum depth is 64.</param>
  1248. </member>
  1249. <member name="M:System.Text.Json.Utf8JsonReader.#ctor(System.ReadOnlySpan{System.Byte},System.Boolean,System.Text.Json.JsonReaderState)">
  1250. <summary>Initializes a new instance of the <see cref="T:System.Text.Json.Utf8JsonReader" /> structure that processes a read-only span of UTF-8 encoded text and indicates whether the input contains all the text to process.</summary>
  1251. <param name="jsonData">The UTF-8 encoded JSON text to process.</param>
  1252. <param name="isFinalBlock">
  1253. <see langword="true" /> to indicate that the input sequence contains the entire data to process; <see langword="false" /> to indicate that the input span contains partial data with more data to follow.</param>
  1254. <param name="state">An object that contains the reader state. If this is the first call to the constructor, pass the default state; otherwise, pass the value of the <see cref="P:System.Text.Json.Utf8JsonReader.CurrentState" /> property from the previous instance of the <see cref="T:System.Text.Json.Utf8JsonReader" />.</param>
  1255. </member>
  1256. <member name="M:System.Text.Json.Utf8JsonReader.#ctor(System.ReadOnlySpan{System.Byte},System.Text.Json.JsonReaderOptions)">
  1257. <summary>Initializes a new instance of the <see cref="T:System.Text.Json.Utf8JsonReader" /> structure that processes a read-only span of UTF-8 encoded text using the specified options.</summary>
  1258. <param name="jsonData">The UTF-8 encoded JSON text to process.</param>
  1259. <param name="options">Defines customized behavior of the <see cref="T:System.Text.Json.Utf8JsonReader" /> that differs from the JSON RFC (for example how to handle comments or maximum depth allowed when reading). By default, the <see cref="T:System.Text.Json.Utf8JsonReader" /> follows the JSON RFC strictly; comments within the JSON are invalid, and the maximum depth is 64.</param>
  1260. </member>
  1261. <member name="P:System.Text.Json.Utf8JsonReader.BytesConsumed">
  1262. <summary>Gets the total number of bytes consumed so far by this instance of the <see cref="T:System.Text.Json.Utf8JsonReader" />.</summary>
  1263. <returns>The total number of bytes consumed so far.</returns>
  1264. </member>
  1265. <member name="P:System.Text.Json.Utf8JsonReader.CurrentDepth">
  1266. <summary>Gets the depth of the current token.</summary>
  1267. <returns>The depth of the current token.</returns>
  1268. </member>
  1269. <member name="P:System.Text.Json.Utf8JsonReader.CurrentState">
  1270. <summary>Gets the current <see cref="T:System.Text.Json.Utf8JsonReader" /> state to pass to a <see cref="T:System.Text.Json.Utf8JsonReader" /> constructor with more data.</summary>
  1271. <returns>The current reader state.</returns>
  1272. </member>
  1273. <member name="M:System.Text.Json.Utf8JsonReader.GetBoolean">
  1274. <summary>Reads the next JSON token value from the source as a <see cref="T:System.Boolean" />.</summary>
  1275. <returns>
  1276. <see langword="true" /> if the <see cref="P:System.Text.Json.Utf8JsonReader.TokenType" /> is <see cref="F:System.Text.Json.JsonTokenType.True" />; <see langword="false" /> if the <see cref="P:System.Text.Json.Utf8JsonReader.TokenType" /> is <see cref="F:System.Text.Json.JsonTokenType.False" />.</returns>
  1277. <exception cref="T:System.InvalidOperationException">The value of the JSON token isn't a boolean value (that is, <see cref="F:System.Text.Json.JsonTokenType.True" /> or <see cref="F:System.Text.Json.JsonTokenType.False" />).</exception>
  1278. </member>
  1279. <member name="M:System.Text.Json.Utf8JsonReader.GetByte">
  1280. <summary>Parses the current JSON token value from the source as a <see cref="T:System.Byte" />.</summary>
  1281. <returns>The value of the UTF-8 encoded token.</returns>
  1282. <exception cref="T:System.InvalidOperationException">The value of the JSON token is not a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1283. <exception cref="T:System.FormatException">The numeric format of the JSON token value is incorrect (for example, it contains a fractional value or is written in scientific notation).
  1284. -or-
  1285. The JSON token value represents a number less than <see cref="F:System.Byte.MinValue" /> or greater than <see cref="F:System.Byte.MaxValue" />.</exception>
  1286. </member>
  1287. <member name="M:System.Text.Json.Utf8JsonReader.GetBytesFromBase64">
  1288. <summary>Parses the current JSON token value from the source and decodes the Base64 encoded JSON string as a byte array.</summary>
  1289. <returns>The byte array that represents the current JSON token value.</returns>
  1290. <exception cref="T:System.InvalidOperationException">The type of the JSON token is not a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
  1291. <exception cref="T:System.FormatException">The value is not encoded as Base64 text, so it can't be decoded to bytes.</exception>
  1292. </member>
  1293. <member name="M:System.Text.Json.Utf8JsonReader.GetComment">
  1294. <summary>Parses the current JSON token value from the source as a comment, transcoded it as a <see cref="T:System.String" />.</summary>
  1295. <returns>The comment that represents the current JSON token value.</returns>
  1296. <exception cref="T:System.InvalidOperationException">The JSON token is not a comment.</exception>
  1297. </member>
  1298. <member name="M:System.Text.Json.Utf8JsonReader.GetDateTime">
  1299. <summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.DateTime" />.</summary>
  1300. <returns>The date and time value, if the entire UTF-8 encoded token value can be successfully parsed.</returns>
  1301. <exception cref="T:System.InvalidOperationException">The value of the JSON token isn't a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
  1302. <exception cref="T:System.FormatException">The JSON token value cannot be read as a <see cref="T:System.DateTime" />.
  1303. -or-
  1304. The entire UTF-8 encoded token value cannot be parsed to a <see cref="T:System.DateTime" /> value.</exception>
  1305. </member>
  1306. <member name="M:System.Text.Json.Utf8JsonReader.GetDateTimeOffset">
  1307. <summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.DateTimeOffset" />.</summary>
  1308. <returns>The date and time offset, if the entire UTF-8 encoded token value can be successfully parsed.</returns>
  1309. <exception cref="T:System.InvalidOperationException">The value of the JSON token isn't a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
  1310. <exception cref="T:System.FormatException">The JSON token value cannot be read as a <see cref="T:System.DateTimeOffset" />.
  1311. -or-
  1312. The entire UTF-8 encoded token value cannot be parsed to a <see cref="T:System.DateTimeOffset" /> value.</exception>
  1313. </member>
  1314. <member name="M:System.Text.Json.Utf8JsonReader.GetDecimal">
  1315. <summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.Decimal" />.</summary>
  1316. <returns>The UTF-8 encoded token value parsed to a <see cref="T:System.Decimal" />.</returns>
  1317. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1318. <exception cref="T:System.FormatException">The JSON token value represents a number less than <see cref="F:System.Decimal.MinValue" /> or greater than <see cref="F:System.Decimal.MaxValue" />.</exception>
  1319. </member>
  1320. <member name="M:System.Text.Json.Utf8JsonReader.GetDouble">
  1321. <summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.Double" />.</summary>
  1322. <returns>The UTF-8 encoded token value parsed to a <see cref="T:System.Double" />.</returns>
  1323. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1324. <exception cref="T:System.FormatException">The JSON token value represents a number less than <see cref="F:System.Double.MinValue" /> or greater than <see cref="F:System.Double.MaxValue" />.</exception>
  1325. </member>
  1326. <member name="M:System.Text.Json.Utf8JsonReader.GetGuid">
  1327. <summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.Guid" />.</summary>
  1328. <returns>The GUID value, if the entire UTF-8 encoded token value can be successfully parsed.</returns>
  1329. <exception cref="T:System.InvalidOperationException">The value of the JSON token isn't a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
  1330. <exception cref="T:System.FormatException">The JSON token value is in an unsupported format for a Guid.
  1331. -or-
  1332. The entire UTF-8 encoded token value cannot be parsed to a <see cref="T:System.Guid" /> value.</exception>
  1333. </member>
  1334. <member name="M:System.Text.Json.Utf8JsonReader.GetInt16">
  1335. <summary>Parses the current JSON token value from the source as a <see cref="T:System.Int16" />.</summary>
  1336. <returns>The UTF-8 encoded token value parsed to an <see cref="T:System.Int16" />.</returns>
  1337. <exception cref="T:System.InvalidOperationException">The value of the JSON token is not a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1338. <exception cref="T:System.FormatException">The numeric format of the JSON token value is incorrect (for example, it contains a fractional value or is written in scientific notation).
  1339. -or-
  1340. The JSON token value represents a number less than <see cref="F:System.Int16.MinValue" /> or greater than <see cref="F:System.Int16.MaxValue" />.</exception>
  1341. </member>
  1342. <member name="M:System.Text.Json.Utf8JsonReader.GetInt32">
  1343. <summary>Reads the next JSON token value from the source and parses it to an <see cref="T:System.Int32" />.</summary>
  1344. <returns>The UTF-8 encoded token value parsed to an <see cref="T:System.Int32" />.</returns>
  1345. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1346. <exception cref="T:System.FormatException">The JSON token value is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation.
  1347. -or-
  1348. The JSON token value represents a number less than <see cref="F:System.Int32.MinValue" /> or greater than <see cref="F:System.Int32.MaxValue" />.</exception>
  1349. </member>
  1350. <member name="M:System.Text.Json.Utf8JsonReader.GetInt64">
  1351. <summary>Reads the next JSON token value from the source and parses it to an <see cref="T:System.Int64" />.</summary>
  1352. <returns>The UTF-8 encoded token value parsed to an <see cref="T:System.Int64" />.</returns>
  1353. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1354. <exception cref="T:System.FormatException">The JSON token value is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation.
  1355. -or-
  1356. The JSON token value represents a number less than <see cref="F:System.Int64.MinValue" /> or greater than <see cref="F:System.Int64.MaxValue" />.</exception>
  1357. </member>
  1358. <member name="M:System.Text.Json.Utf8JsonReader.GetSByte">
  1359. <summary>Parses the current JSON token value from the source as an <see cref="T:System.SByte" />.</summary>
  1360. <returns>The UTF-8 encoded token value parsed to an <see cref="T:System.SByte" />.</returns>
  1361. <exception cref="T:System.InvalidOperationException">The value of the JSON token is not a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1362. <exception cref="T:System.FormatException">The numeric format of the JSON token value is incorrect (for example, it contains a fractional value or is written in scientific notation).
  1363. -or-
  1364. The JSON token value represents a number less than <see cref="F:System.SByte.MinValue" /> or greater than <see cref="F:System.SByte.MaxValue" />.</exception>
  1365. </member>
  1366. <member name="M:System.Text.Json.Utf8JsonReader.GetSingle">
  1367. <summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.Single" />.</summary>
  1368. <returns>The UTF-8 encoded token value parsed to a <see cref="T:System.Single" />.</returns>
  1369. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1370. <exception cref="T:System.FormatException">The JSON token value represents a number less than <see cref="F:System.Single.MinValue" /> or greater than <see cref="F:System.Single.MaxValue" />.</exception>
  1371. </member>
  1372. <member name="M:System.Text.Json.Utf8JsonReader.GetString">
  1373. <summary>Reads the next JSON token value from the source, unescaped, and transcoded as a string.</summary>
  1374. <returns>The token value parsed to a string, or <see langword="null" /> if <see cref="P:System.Text.Json.Utf8JsonReader.TokenType" /> is <see cref="F:System.Text.Json.JsonTokenType.Null" />.</returns>
  1375. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a string (that is, not a <see cref="F:System.Text.Json.JsonTokenType.String" />, <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />, or <see cref="F:System.Text.Json.JsonTokenType.Null" />).
  1376. -or-
  1377. The JSON string contains invalid UTF-8 bytes or invalid UTF-16 surrogates.</exception>
  1378. </member>
  1379. <member name="M:System.Text.Json.Utf8JsonReader.GetUInt16">
  1380. <summary>Parses the current JSON token value from the source as a <see cref="T:System.UInt16" />.</summary>
  1381. <returns>The UTF-8 encoded token value parsed to a <see cref="T:System.UInt16" />.</returns>
  1382. <exception cref="T:System.InvalidOperationException">The value of the JSON token is not a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1383. <exception cref="T:System.FormatException">The numeric format of the JSON token value is incorrect (for example, it contains a fractional value or is written in scientific notation).
  1384. -or-
  1385. The JSON token value represents a number less than <see cref="F:System.UInt16.MinValue" /> or greater than <see cref="F:System.UInt16.MaxValue" />.</exception>
  1386. </member>
  1387. <member name="M:System.Text.Json.Utf8JsonReader.GetUInt32">
  1388. <summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.UInt32" />.</summary>
  1389. <returns>The UTF-8 encoded token value parsed to a <see cref="T:System.UInt32" />.</returns>
  1390. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1391. <exception cref="T:System.FormatException">The JSON token value is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation.
  1392. -or-
  1393. The JSON token value represents a number less than <see cref="F:System.UInt32.MinValue" /> or greater than <see cref="F:System.UInt32.MaxValue" />.</exception>
  1394. </member>
  1395. <member name="M:System.Text.Json.Utf8JsonReader.GetUInt64">
  1396. <summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.UInt64" />.</summary>
  1397. <returns>The UTF-8 encoded token value parsed to a <see cref="T:System.UInt64" />.</returns>
  1398. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1399. <exception cref="T:System.FormatException">The JSON token value is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation.
  1400. -or-
  1401. The JSON token value represents a number less than <see cref="F:System.UInt64.MinValue" /> or greater than <see cref="F:System.UInt64.MaxValue" />.</exception>
  1402. </member>
  1403. <member name="P:System.Text.Json.Utf8JsonReader.HasValueSequence">
  1404. <summary>Gets a value that indicates which <c>Value</c> property to use to get the token value.</summary>
  1405. <returns>
  1406. <see langword="true" /> if <see cref="P:System.Text.Json.Utf8JsonReader.ValueSequence" /> should be used to get the token value; <see langword="false" /> if <see cref="P:System.Text.Json.Utf8JsonReader.ValueSpan" /> should be used instead.</returns>
  1407. </member>
  1408. <member name="P:System.Text.Json.Utf8JsonReader.IsFinalBlock">
  1409. <summary>Gets the mode of this instance of the <see cref="T:System.Text.Json.Utf8JsonReader" /> which indicates whether all the JSON data was provided or there is more data to come.</summary>
  1410. <returns>
  1411. <see langword="true" /> if the reader was constructed with the input span or sequence containing the entire JSON data to process; <see langword="false" /> if the reader was constructed with an input span or sequence that may contain partial JSON data with more data to follow.</returns>
  1412. </member>
  1413. <member name="P:System.Text.Json.Utf8JsonReader.Position">
  1414. <summary>Gets the current <see cref="T:System.SequencePosition" /> within the provided UTF-8 encoded input ReadOnlySequence&lt;byte&gt; or a default <see cref="T:System.SequencePosition" /> if the <see cref="T:System.Text.Json.Utf8JsonReader" /> struct was constructed with a ReadOnlySpan&lt;byte&gt;.</summary>
  1415. <returns>The current <see cref="T:System.SequencePosition" /> within the provided UTF-8 encoded input ReadOnlySequence&lt;byte&gt; or a default <see cref="T:System.SequencePosition" /> if the <see cref="T:System.Text.Json.Utf8JsonReader" /> struct was constructed with a ReadOnlySpan&lt;byte&gt;.</returns>
  1416. </member>
  1417. <member name="M:System.Text.Json.Utf8JsonReader.Read">
  1418. <summary>Reads the next JSON token from the input source.</summary>
  1419. <returns>
  1420. <see langword="true" /> if the token was read successfully; otherwise, <see langword="false" />.</returns>
  1421. <exception cref="T:System.Text.Json.JsonException">An invalid JSON token according to the JSON RFC is encountered.
  1422. -or-
  1423. The current depth exceeds the recursive limit set by the maximum depth.</exception>
  1424. </member>
  1425. <member name="M:System.Text.Json.Utf8JsonReader.Skip">
  1426. <summary>Skips the children of the current JSON token.</summary>
  1427. <exception cref="T:System.InvalidOperationException">The reader was given partial data with more data to follow (that is, <see cref="P:System.Text.Json.Utf8JsonReader.IsFinalBlock" /> is <see langword="false" />).</exception>
  1428. <exception cref="T:System.Text.Json.JsonException">An invalid JSON token was encountered while skipping, according to the JSON RFC.
  1429. -or-
  1430. The current depth exceeds the recursive limit set by the maximum depth.</exception>
  1431. </member>
  1432. <member name="P:System.Text.Json.Utf8JsonReader.TokenStartIndex">
  1433. <summary>Gets the index that the last processed JSON token starts at (within the given UTF-8 encoded input text), skipping any white space.</summary>
  1434. <returns>The starting index of the last processed JSON token within the given UTF-8 encoded input text.</returns>
  1435. </member>
  1436. <member name="P:System.Text.Json.Utf8JsonReader.TokenType">
  1437. <summary>Gets the type of the last processed JSON token in the UTF-8 encoded JSON text.</summary>
  1438. <returns>The type of the last processed JSON token.</returns>
  1439. </member>
  1440. <member name="M:System.Text.Json.Utf8JsonReader.TryGetByte(System.Byte@)">
  1441. <summary>Tries to parse the current JSON token value from the source as a <see cref="T:System.Byte" /> and returns a value that indicates whether the operation succeeded.</summary>
  1442. <param name="value">When this method returns, contains the parsed value.</param>
  1443. <returns>
  1444. <see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="T:System.Byte" /> value; otherwise, <see langword="false" />.</returns>
  1445. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1446. </member>
  1447. <member name="M:System.Text.Json.Utf8JsonReader.TryGetBytesFromBase64(System.Byte[]@)">
  1448. <summary>Tries to parse the current JSON token value from the source and decodes the Base64 encoded JSON string as a byte array and returns a value that indicates whether the operation succeeded.</summary>
  1449. <param name="value">When this method returns, contains the decoded binary representation of the Base64 text.</param>
  1450. <returns>
  1451. <see langword="true" /> if the entire token value is encoded as valid Base64 text and can be successfully decoded to bytes; otherwise, <see langword="false" />.</returns>
  1452. <exception cref="T:System.InvalidOperationException">The JSON token is not a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
  1453. </member>
  1454. <member name="M:System.Text.Json.Utf8JsonReader.TryGetDateTime(System.DateTime@)">
  1455. <summary>Tries to parse the current JSON token value from the source as a <see cref="T:System.DateTime" /> and returns a value that indicates whether the operation succeeded.</summary>
  1456. <param name="value">When this method returns, contains the parsed value.</param>
  1457. <returns>
  1458. <see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="T:System.DateTime" /> value; otherwise, <see langword="false" />.</returns>
  1459. <exception cref="T:System.InvalidOperationException">The value of the JSON token isn't a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
  1460. </member>
  1461. <member name="M:System.Text.Json.Utf8JsonReader.TryGetDateTimeOffset(System.DateTimeOffset@)">
  1462. <summary>Tries to parse the current JSON token value from the source as a <see cref="T:System.DateTimeOffset" /> and returns a value that indicates whether the operation succeeded.</summary>
  1463. <param name="value">When this method returns, contains the parsed value.</param>
  1464. <returns>
  1465. <see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="T:System.DateTimeOffset" /> value; otherwise, <see langword="false" />.</returns>
  1466. <exception cref="T:System.InvalidOperationException">The value of the JSON token isn't a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
  1467. </member>
  1468. <member name="M:System.Text.Json.Utf8JsonReader.TryGetDecimal(System.Decimal@)">
  1469. <summary>Tries to parse the current JSON token value from the source as a <see cref="T:System.Decimal" /> and returns a value that indicates whether the operation succeeded.</summary>
  1470. <param name="value">When this method returns, contains the parsed value.</param>
  1471. <returns>
  1472. <see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="T:System.Decimal" /> value; otherwise, <see langword="false" />.</returns>
  1473. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1474. </member>
  1475. <member name="M:System.Text.Json.Utf8JsonReader.TryGetDouble(System.Double@)">
  1476. <summary>Tries to parse the current JSON token value from the source as a <see cref="T:System.Double" /> and returns a value that indicates whether the operation succeeded.</summary>
  1477. <param name="value">When this method returns, contains the parsed value.</param>
  1478. <returns>
  1479. <see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="T:System.Double" /> value; otherwise, <see langword="false" />.</returns>
  1480. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1481. </member>
  1482. <member name="M:System.Text.Json.Utf8JsonReader.TryGetGuid(System.Guid@)">
  1483. <summary>Tries to parse the current JSON token value from the source as a <see cref="T:System.Guid" /> and returns a value that indicates whether the operation succeeded.</summary>
  1484. <param name="value">When this method returns, contains the parsed value.</param>
  1485. <returns>
  1486. <see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="T:System.Guid" /> value; otherwise, <see langword="false" />.</returns>
  1487. <exception cref="T:System.InvalidOperationException">The value of the JSON token isn't a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
  1488. </member>
  1489. <member name="M:System.Text.Json.Utf8JsonReader.TryGetInt16(System.Int16@)">
  1490. <summary>Tries to parse the current JSON token value from the source as an <see cref="T:System.Int16" /> and returns a value that indicates whether the operation succeeded.</summary>
  1491. <param name="value">When this method returns, contains the parsed value.</param>
  1492. <returns>
  1493. <see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="T:System.Int16" /> value; otherwise, <see langword="false" />.</returns>
  1494. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1495. </member>
  1496. <member name="M:System.Text.Json.Utf8JsonReader.TryGetInt32(System.Int32@)">
  1497. <summary>Tries to parse the current JSON token value from the source as an <see cref="T:System.Int32" /> and returns a value that indicates whether the operation succeeded.</summary>
  1498. <param name="value">When this method returns, contains the parsed value.</param>
  1499. <returns>
  1500. <see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to an <see cref="T:System.Int32" /> value; otherwise, <see langword="false" />.</returns>
  1501. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1502. </member>
  1503. <member name="M:System.Text.Json.Utf8JsonReader.TryGetInt64(System.Int64@)">
  1504. <summary>Tries to parse the current JSON token value from the source as an <see cref="T:System.Int64" /> and returns a value that indicates whether the operation succeeded.</summary>
  1505. <param name="value">When this method returns, contains the parsed value.</param>
  1506. <returns>
  1507. <see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to an <see cref="T:System.Int64" /> value; otherwise, <see langword="false" />.</returns>
  1508. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1509. </member>
  1510. <member name="M:System.Text.Json.Utf8JsonReader.TryGetSByte(System.SByte@)">
  1511. <summary>Tries to parse the current JSON token value from the source as an <see cref="T:System.SByte" /> and returns a value that indicates whether the operation succeeded.</summary>
  1512. <param name="value">When this method returns, contains the parsed value.</param>
  1513. <returns>
  1514. <see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to an <see cref="T:System.SByte" /> value; otherwise, <see langword="false" />.</returns>
  1515. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1516. </member>
  1517. <member name="M:System.Text.Json.Utf8JsonReader.TryGetSingle(System.Single@)">
  1518. <summary>Tries to parse the current JSON token value from the source as a <see cref="T:System.Single" /> and returns a value that indicates whether the operation succeeded.</summary>
  1519. <param name="value">When this method returns, contains the parsed value.</param>
  1520. <returns>
  1521. <see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to an <see cref="T:System.Single" /> value; otherwise, <see langword="false" />.</returns>
  1522. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1523. </member>
  1524. <member name="M:System.Text.Json.Utf8JsonReader.TryGetUInt16(System.UInt16@)">
  1525. <summary>Tries to parse the current JSON token value from the source as a <see cref="T:System.UInt16" /> and returns a value that indicates whether the operation succeeded.</summary>
  1526. <param name="value">When this method returns, contains the parsed value.</param>
  1527. <returns>
  1528. <see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="T:System.UInt16" /> value; otherwise, <see langword="false" />.</returns>
  1529. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1530. </member>
  1531. <member name="M:System.Text.Json.Utf8JsonReader.TryGetUInt32(System.UInt32@)">
  1532. <summary>Tries to parse the current JSON token value from the source as a <see cref="T:System.UInt32" /> and returns a value that indicates whether the operation succeeded.</summary>
  1533. <param name="value">When this method returns, contains the parsed value.</param>
  1534. <returns>
  1535. <see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="T:System.UInt32" /> value; otherwise, <see langword="false" />.</returns>
  1536. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1537. </member>
  1538. <member name="M:System.Text.Json.Utf8JsonReader.TryGetUInt64(System.UInt64@)">
  1539. <summary>Tries to parse the current JSON token value from the source as a <see cref="T:System.UInt64" /> and returns a value that indicates whether the operation succeeded.</summary>
  1540. <param name="value">When this method returns, contains the parsed value.</param>
  1541. <returns>
  1542. <see langword="true" /> if the entire UTF-8 encoded token value can be successfully parsed to a <see cref="T:System.UInt64" /> value; otherwise, <see langword="false" />.</returns>
  1543. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1544. </member>
  1545. <member name="M:System.Text.Json.Utf8JsonReader.TrySkip">
  1546. <summary>Tries to skip the children of the current JSON token.</summary>
  1547. <returns>
  1548. <see langword="true" /> if there was enough data for the children to be skipped successfully; otherwise, <see langword="false" />.</returns>
  1549. <exception cref="T:System.Text.Json.JsonException">An invalid JSON token was encountered while skipping, according to the JSON RFC.
  1550. -or -
  1551. The current depth exceeds the recursive limit set by the maximum depth.</exception>
  1552. </member>
  1553. <member name="P:System.Text.Json.Utf8JsonReader.ValueSequence">
  1554. <summary>Gets the raw value of the last processed token as a ReadOnlySequence&lt;byte&gt; slice of the input payload, only if the token is contained within multiple segments.</summary>
  1555. <returns>A byte read-only sequence.</returns>
  1556. </member>
  1557. <member name="P:System.Text.Json.Utf8JsonReader.ValueSpan">
  1558. <summary>Gets the raw value of the last processed token as a ReadOnlySpan&lt;byte&gt; slice of the input payload, if the token fits in a single segment or if the reader was constructed with a JSON payload contained in a ReadOnlySpan&lt;byte&gt;.</summary>
  1559. <returns>A read-only span of bytes.</returns>
  1560. </member>
  1561. <member name="M:System.Text.Json.Utf8JsonReader.ValueTextEquals(System.ReadOnlySpan{System.Byte})">
  1562. <summary>Compares the UTF-8 encoded text in a read-only byte span to the unescaped JSON token value in the source and returns a value that indicates whether they match.</summary>
  1563. <param name="utf8Text">The UTF-8 encoded text to compare against.</param>
  1564. <returns>
  1565. <see langword="true" /> if the JSON token value in the source matches the UTF-8 encoded lookup text; otherwise, <see langword="false" />.</returns>
  1566. <exception cref="T:System.InvalidOperationException">The JSON token is not a JSON string (that is, it is not <see cref="F:System.Text.Json.JsonTokenType.String" /> or <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />).</exception>
  1567. </member>
  1568. <member name="M:System.Text.Json.Utf8JsonReader.ValueTextEquals(System.ReadOnlySpan{System.Char})">
  1569. <summary>Compares the text in a read-only character span to the unescaped JSON token value in the source and returns a value that indicates whether they match.</summary>
  1570. <param name="text">The text to compare against.</param>
  1571. <returns>
  1572. <see langword="true" /> if the JSON token value in the source matches the lookup text; otherwise, <see langword="false" />.</returns>
  1573. <exception cref="T:System.InvalidOperationException">The JSON token is not a JSON string (that is, it is not <see cref="F:System.Text.Json.JsonTokenType.String" /> or <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />).</exception>
  1574. </member>
  1575. <member name="M:System.Text.Json.Utf8JsonReader.ValueTextEquals(System.String)">
  1576. <summary>Compares the string text to the unescaped JSON token value in the source and returns a value that indicates whether they match.</summary>
  1577. <param name="text">The text to compare against.</param>
  1578. <returns>
  1579. <see langword="true" /> if the JSON token value in the source matches the lookup text; otherwise, <see langword="false" />.</returns>
  1580. <exception cref="T:System.InvalidOperationException">The JSON token is not a JSON string (that is, it is not <see cref="F:System.Text.Json.JsonTokenType.String" /> or <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />).</exception>
  1581. </member>
  1582. <member name="T:System.Text.Json.Utf8JsonWriter">
  1583. <summary>Provides a high-performance API for forward-only, non-cached writing of UTF-8 encoded JSON text.</summary>
  1584. </member>
  1585. <member name="M:System.Text.Json.Utf8JsonWriter.#ctor(System.Buffers.IBufferWriter{System.Byte},System.Text.Json.JsonWriterOptions)">
  1586. <summary>Initializes a new instance of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> class using the specified <see cref="T:System.Buffers.IBufferWriter`1" /> to write the output to and customization options.</summary>
  1587. <param name="bufferWriter">The destination for writing JSON text.</param>
  1588. <param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" />. By default, it writes minimized JSON (with no extra white space) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>
  1589. <exception cref="T:System.ArgumentNullException">
  1590. <paramref name="bufferWriter" /> is <see langword="null" />.</exception>
  1591. </member>
  1592. <member name="M:System.Text.Json.Utf8JsonWriter.#ctor(System.IO.Stream,System.Text.Json.JsonWriterOptions)">
  1593. <summary>Initializes a new instance of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> class using the specified stream to write the output to and customization options.</summary>
  1594. <param name="utf8Json">The destination for writing JSON text.</param>
  1595. <param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" />. By default, it writes minimized JSON (with no extra white space) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>
  1596. <exception cref="T:System.ArgumentNullException">
  1597. <paramref name="utf8Json" /> is <see langword="null" />.</exception>
  1598. </member>
  1599. <member name="P:System.Text.Json.Utf8JsonWriter.BytesCommitted">
  1600. <summary>Gets the total number of bytes committed to the output by the current instance so far.</summary>
  1601. <returns>The total number of bytes committed to the output by the <see cref="T:System.Text.Json.Utf8JsonWriter" /> so far.</returns>
  1602. </member>
  1603. <member name="P:System.Text.Json.Utf8JsonWriter.BytesPending">
  1604. <summary>Gets the number of bytes written by the <see cref="T:System.Text.Json.Utf8JsonWriter" /> so far that have not yet been flushed to the output and committed.</summary>
  1605. <returns>The number of bytes written so far by the <see cref="T:System.Text.Json.Utf8JsonWriter" /> that have not yet been flushed to the output and committed.</returns>
  1606. </member>
  1607. <member name="P:System.Text.Json.Utf8JsonWriter.CurrentDepth">
  1608. <summary>Gets the depth of the current token.</summary>
  1609. <returns>The depth of the current token.</returns>
  1610. </member>
  1611. <member name="M:System.Text.Json.Utf8JsonWriter.Dispose">
  1612. <summary>Commits any leftover JSON text that has not yet been flushed and releases all resources used by the current instance.</summary>
  1613. </member>
  1614. <member name="M:System.Text.Json.Utf8JsonWriter.DisposeAsync">
  1615. <summary>Asynchronously commits any leftover JSON text that has not yet been flushed and releases all resources used by the current instance.</summary>
  1616. <returns>A task representing the asynchronous dispose operation.</returns>
  1617. </member>
  1618. <member name="M:System.Text.Json.Utf8JsonWriter.Flush">
  1619. <summary>Commits the JSON text written so far, which makes it visible to the output destination.</summary>
  1620. <exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
  1621. </member>
  1622. <member name="M:System.Text.Json.Utf8JsonWriter.FlushAsync(System.Threading.CancellationToken)">
  1623. <summary>Asynchronously commits the JSON text written so far, which makes it visible to the output destination.</summary>
  1624. <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
  1625. <returns>A task representing the asynchronous flush operation.</returns>
  1626. <exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
  1627. </member>
  1628. <member name="P:System.Text.Json.Utf8JsonWriter.Options">
  1629. <summary>Gets the custom behavior when writing JSON using this instance, which indicates whether to format the output while writing, whether to skip structural JSON validation, and which characters to escape.</summary>
  1630. <returns>The custom behavior of this instance of the writer for formatting, validating, and escaping.</returns>
  1631. </member>
  1632. <member name="M:System.Text.Json.Utf8JsonWriter.Reset">
  1633. <summary>Resets the internal state of this instance so that it can be reused.</summary>
  1634. <exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
  1635. </member>
  1636. <member name="M:System.Text.Json.Utf8JsonWriter.Reset(System.Buffers.IBufferWriter{System.Byte})">
  1637. <summary>Resets the internal state of this instance so that it can be reused with a new instance of <see cref="T:System.Buffers.IBufferWriter`1" />.</summary>
  1638. <param name="bufferWriter">The destination for writing JSON text.</param>
  1639. <exception cref="T:System.ArgumentNullException">
  1640. <paramref name="bufferWriter" /> is <see langword="null" />.</exception>
  1641. <exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
  1642. </member>
  1643. <member name="M:System.Text.Json.Utf8JsonWriter.Reset(System.IO.Stream)">
  1644. <summary>Resets the internal state of this instance so that it can be reused with a new instance of <see cref="T:System.IO.Stream" />.</summary>
  1645. <param name="utf8Json">The destination for writing JSON text.</param>
  1646. <exception cref="T:System.ArgumentNullException">
  1647. <paramref name="utf8Json" /> is <see langword="null" />.</exception>
  1648. <exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
  1649. </member>
  1650. <member name="M:System.Text.Json.Utf8JsonWriter.WriteBase64String(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte})">
  1651. <summary>Writes the property name and raw bytes value (as a Base64 encoded JSON string) as part of a name/value pair of a JSON object.</summary>
  1652. <param name="utf8PropertyName">The UTF-8 encoded name of the property to write.</param>
  1653. <param name="bytes">The binary data to write as Base64 encoded text.</param>
  1654. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  1655. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  1656. </member>
  1657. <member name="M:System.Text.Json.Utf8JsonWriter.WriteBase64String(System.ReadOnlySpan{System.Char},System.ReadOnlySpan{System.Byte})">
  1658. <summary>Writes the property name and raw bytes value (as a Base64 encoded JSON string) as part of a name/value pair of a JSON object.</summary>
  1659. <param name="propertyName">The property name of the JSON object to be transcoded and written as UTF-8.</param>
  1660. <param name="bytes">The binary data to write as Base64 encoded text.</param>
  1661. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  1662. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  1663. </member>
  1664. <member name="M:System.Text.Json.Utf8JsonWriter.WriteBase64String(System.String,System.ReadOnlySpan{System.Byte})">
  1665. <summary>Writes the property name and raw bytes value (as a Base64 encoded JSON string) as part of a name/value pair of a JSON object.</summary>
  1666. <param name="propertyName">The property name of the JSON object to be transcoded and written as UTF-8.</param>
  1667. <param name="bytes">The binary data to write as Base64 encoded text.</param>
  1668. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  1669. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  1670. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  1671. </member>
  1672. <member name="M:System.Text.Json.Utf8JsonWriter.WriteBase64String(System.Text.Json.JsonEncodedText,System.ReadOnlySpan{System.Byte})">
  1673. <summary>Writes the pre-encoded property name and raw bytes value (as a Base64 encoded JSON string) as part of a name/value pair of a JSON object.</summary>
  1674. <param name="propertyName">The JSON-encoded name of the property to write.</param>
  1675. <param name="bytes">The binary data to write as Base64 encoded text.</param>
  1676. <exception cref="T:System.ArgumentException">The specified value is too large.</exception>
  1677. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  1678. </member>
  1679. <member name="M:System.Text.Json.Utf8JsonWriter.WriteBase64StringValue(System.ReadOnlySpan{System.Byte})">
  1680. <summary>Writes the raw bytes value as a Base64 encoded JSON string as an element of a JSON array.</summary>
  1681. <param name="bytes">The binary data to be written as a Base64 encoded JSON string element of a JSON array.</param>
  1682. <exception cref="T:System.ArgumentException">The specified value is too large.</exception>
  1683. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  1684. </member>
  1685. <member name="M:System.Text.Json.Utf8JsonWriter.WriteBoolean(System.ReadOnlySpan{System.Byte},System.Boolean)">
  1686. <summary>Writes a property name specified as a read-only span of bytes and a <see cref="T:System.Boolean" /> value (as a JSON literal true or false) as part of a name/value pair of a JSON object.</summary>
  1687. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  1688. <param name="value">The value to be written as a JSON literal true or false as part of the name/value pair.</param>
  1689. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1690. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  1691. </member>
  1692. <member name="M:System.Text.Json.Utf8JsonWriter.WriteBoolean(System.ReadOnlySpan{System.Char},System.Boolean)">
  1693. <summary>Writes a property name specified as a read-only character span and a <see cref="T:System.Boolean" /> value (as a JSON literal true or false) as part of a name/value pair of a JSON object.</summary>
  1694. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1695. <param name="value">The value to be written as a JSON literal true or false as part of the name/value pair.</param>
  1696. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1697. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  1698. </member>
  1699. <member name="M:System.Text.Json.Utf8JsonWriter.WriteBoolean(System.String,System.Boolean)">
  1700. <summary>Writes a property name specified as a string and a <see cref="T:System.Boolean" /> value (as a JSON literal true or false) as part of a name/value pair of a JSON object.</summary>
  1701. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1702. <param name="value">The value to be written as a JSON literal true or false as part of the name/value pair.</param>
  1703. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1704. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  1705. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  1706. </member>
  1707. <member name="M:System.Text.Json.Utf8JsonWriter.WriteBoolean(System.Text.Json.JsonEncodedText,System.Boolean)">
  1708. <summary>Writes the pre-encoded property name and <see cref="T:System.Boolean" /> value (as a JSON literal true or false) as part of a name/value pair of a JSON object.</summary>
  1709. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1710. <param name="value">The value to be written as a JSON literal true or false as part of the name/value pair.</param>
  1711. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  1712. </member>
  1713. <member name="M:System.Text.Json.Utf8JsonWriter.WriteBooleanValue(System.Boolean)">
  1714. <summary>Writes a <see cref="T:System.Boolean" /> value (as a JSON literal true or false) as an element of a JSON array.</summary>
  1715. <param name="value">The value to be written as a JSON literal true or false as an element of a JSON array.</param>
  1716. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  1717. </member>
  1718. <member name="M:System.Text.Json.Utf8JsonWriter.WriteCommentValue(System.ReadOnlySpan{System.Byte})">
  1719. <summary>Writes a UTF-8 text value as a JSON comment.</summary>
  1720. <param name="utf8Value">The UTF-8 encoded value to be written as a JSON comment within /*..*/.</param>
  1721. <exception cref="T:System.ArgumentException">The specified value is too large.
  1722. -or-
  1723. <paramref name="utf8Value" /> contains a comment delimiter (that is, */).</exception>
  1724. </member>
  1725. <member name="M:System.Text.Json.Utf8JsonWriter.WriteCommentValue(System.ReadOnlySpan{System.Char})">
  1726. <summary>Writes a UTF-16 text value as a JSON comment.</summary>
  1727. <param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within /*..*/.</param>
  1728. <exception cref="T:System.ArgumentException">The specified value is too large.
  1729. -or-
  1730. <paramref name="value" /> contains a comment delimiter (that is, */).</exception>
  1731. </member>
  1732. <member name="M:System.Text.Json.Utf8JsonWriter.WriteCommentValue(System.String)">
  1733. <summary>Writes a string text value as a JSON comment.</summary>
  1734. <param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within /*..*/.</param>
  1735. <exception cref="T:System.ArgumentException">The specified value is too large.
  1736. -or-
  1737. <paramref name="value" /> contains a comment delimiter (that is, */).</exception>
  1738. <exception cref="T:System.ArgumentNullException">The <paramref name="value" /> parameter is <see langword="null" />.</exception>
  1739. </member>
  1740. <member name="M:System.Text.Json.Utf8JsonWriter.WriteEndArray">
  1741. <summary>Writes the end of a JSON array.</summary>
  1742. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  1743. </member>
  1744. <member name="M:System.Text.Json.Utf8JsonWriter.WriteEndObject">
  1745. <summary>Writes the end of a JSON object.</summary>
  1746. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  1747. </member>
  1748. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNull(System.ReadOnlySpan{System.Byte})">
  1749. <summary>Writes a property name specified as a read-only span of bytes and the JSON literal null as part of a name/value pair of a JSON object.</summary>
  1750. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  1751. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1752. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1753. </member>
  1754. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNull(System.ReadOnlySpan{System.Char})">
  1755. <summary>Writes a property name specified as a read-only character span and the JSON literal null as part of a name/value pair of a JSON object.</summary>
  1756. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1757. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1758. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1759. </member>
  1760. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNull(System.String)">
  1761. <summary>Writes a property name specified as a string and the JSON literal null as part of a name/value pair of a JSON object.</summary>
  1762. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1763. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1764. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1765. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  1766. </member>
  1767. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNull(System.Text.Json.JsonEncodedText)">
  1768. <summary>Writes the pre-encoded property name and the JSON literal null as part of a name/value pair of a JSON object.</summary>
  1769. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1770. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  1771. </member>
  1772. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNullValue">
  1773. <summary>Writes the JSON literal null as an element of a JSON array.</summary>
  1774. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  1775. </member>
  1776. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Byte},System.Decimal)">
  1777. <summary>Writes a property name specified as a read-only span of bytes and a <see cref="T:System.Decimal" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1778. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  1779. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1780. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1781. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1782. </member>
  1783. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Byte},System.Double)">
  1784. <summary>Writes a property name specified as a read-only span of bytes and a <see cref="T:System.Double" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1785. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  1786. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1787. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1788. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1789. </member>
  1790. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Byte},System.Int32)">
  1791. <summary>Writes a property name specified as a read-only span of bytes and an <see cref="T:System.Int32" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1792. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  1793. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1794. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1795. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1796. </member>
  1797. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Byte},System.Int64)">
  1798. <summary>Writes a property name specified as a read-only span of bytes and an <see cref="T:System.Int64" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1799. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  1800. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1801. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1802. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1803. </member>
  1804. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Byte},System.Single)">
  1805. <summary>Writes a property name specified as a read-only span of bytes and a <see cref="T:System.Single" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1806. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  1807. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1808. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1809. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1810. </member>
  1811. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Byte},System.UInt32)">
  1812. <summary>Writes a property name specified as a read-only span of bytes and a <see cref="T:System.UInt32" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1813. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  1814. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1815. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1816. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1817. </member>
  1818. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Byte},System.UInt64)">
  1819. <summary>Writes a property name specified as a read-only span of bytes and a <see cref="T:System.UInt64" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1820. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  1821. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1822. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1823. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1824. </member>
  1825. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Char},System.Decimal)">
  1826. <summary>Writes a property name specified as a read-only character span and a <see cref="T:System.Decimal" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1827. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1828. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1829. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1830. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1831. </member>
  1832. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Char},System.Double)">
  1833. <summary>Writes a property name specified as a read-only character span and a <see cref="T:System.Double" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1834. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1835. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1836. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1837. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1838. </member>
  1839. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Char},System.Int32)">
  1840. <summary>Writes a property name specified as a read-only character span and an <see cref="T:System.Int32" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1841. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1842. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1843. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1844. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1845. </member>
  1846. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Char},System.Int64)">
  1847. <summary>Writes a property name specified as a read-only character span and an <see cref="T:System.Int64" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1848. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1849. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1850. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1851. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1852. </member>
  1853. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Char},System.Single)">
  1854. <summary>Writes a property name specified as a read-only character span and a <see cref="T:System.Single" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1855. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1856. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1857. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1858. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1859. </member>
  1860. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Char},System.UInt32)">
  1861. <summary>Writes a property name specified as a read-only character span and a <see cref="T:System.UInt32" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1862. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1863. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1864. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1865. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1866. </member>
  1867. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Char},System.UInt64)">
  1868. <summary>Writes a property name specified as a read-only character span and a <see cref="T:System.UInt64" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1869. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1870. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1871. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1872. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1873. </member>
  1874. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.String,System.Decimal)">
  1875. <summary>Writes a property name specified as a string and a <see cref="T:System.Decimal" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1876. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1877. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1878. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1879. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1880. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  1881. </member>
  1882. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.String,System.Double)">
  1883. <summary>Writes a property name specified as a string and a <see cref="T:System.Double" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1884. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1885. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1886. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1887. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1888. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  1889. </member>
  1890. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.String,System.Int32)">
  1891. <summary>Writes a property name specified as a string and an <see cref="T:System.Int32" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1892. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1893. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1894. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1895. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1896. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  1897. </member>
  1898. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.String,System.Int64)">
  1899. <summary>Writes a property name specified as a string and an <see cref="T:System.Int64" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1900. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1901. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1902. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1903. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1904. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  1905. </member>
  1906. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.String,System.Single)">
  1907. <summary>Writes a property name specified as a string and a <see cref="T:System.Single" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1908. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1909. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1910. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1911. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1912. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  1913. </member>
  1914. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.String,System.UInt32)">
  1915. <summary>Writes a property name specified as a string and a <see cref="T:System.UInt32" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1916. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1917. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1918. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1919. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1920. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  1921. </member>
  1922. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.String,System.UInt64)">
  1923. <summary>Writes a property name specified as a string and a <see cref="T:System.UInt64" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1924. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1925. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1926. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1927. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1928. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  1929. </member>
  1930. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.Text.Json.JsonEncodedText,System.Decimal)">
  1931. <summary>Writes the pre-encoded property name and <see cref="T:System.Decimal" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1932. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1933. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1934. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  1935. </member>
  1936. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.Text.Json.JsonEncodedText,System.Double)">
  1937. <summary>Writes the pre-encoded property name and <see cref="T:System.Double" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1938. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1939. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1940. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  1941. </member>
  1942. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.Text.Json.JsonEncodedText,System.Int32)">
  1943. <summary>Writes the pre-encoded property name and <see cref="T:System.Int32" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1944. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1945. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1946. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  1947. </member>
  1948. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.Text.Json.JsonEncodedText,System.Int64)">
  1949. <summary>Writes the pre-encoded property name and <see cref="T:System.Int64" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1950. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1951. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1952. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  1953. </member>
  1954. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.Text.Json.JsonEncodedText,System.Single)">
  1955. <summary>Writes the pre-encoded property name and <see cref="T:System.Single" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1956. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1957. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1958. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  1959. </member>
  1960. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.Text.Json.JsonEncodedText,System.UInt32)">
  1961. <summary>Writes the pre-encoded property name and <see cref="T:System.UInt32" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1962. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1963. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1964. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  1965. </member>
  1966. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.Text.Json.JsonEncodedText,System.UInt64)">
  1967. <summary>Writes the pre-encoded property name and <see cref="T:System.UInt64" /> value (as a JSON number) as part of a name/value pair of a JSON object.</summary>
  1968. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1969. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1970. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  1971. </member>
  1972. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumberValue(System.Decimal)">
  1973. <summary>Writes a <see cref="T:System.Decimal" /> value (as a JSON number) as an element of a JSON array.</summary>
  1974. <param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
  1975. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  1976. </member>
  1977. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumberValue(System.Double)">
  1978. <summary>Writes a <see cref="T:System.Double" /> value (as a JSON number) as an element of a JSON array.</summary>
  1979. <param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
  1980. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  1981. </member>
  1982. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumberValue(System.Int32)">
  1983. <summary>Writes an <see cref="T:System.Int32" /> value (as a JSON number) as an element of a JSON array.</summary>
  1984. <param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
  1985. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  1986. </member>
  1987. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumberValue(System.Int64)">
  1988. <summary>Writes an <see cref="T:System.Int64" /> value (as a JSON number) as an element of a JSON array.</summary>
  1989. <param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
  1990. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  1991. </member>
  1992. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumberValue(System.Single)">
  1993. <summary>Writes a <see cref="T:System.Single" /> value (as a JSON number) as an element of a JSON array.</summary>
  1994. <param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
  1995. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  1996. </member>
  1997. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumberValue(System.UInt32)">
  1998. <summary>Writes a <see cref="T:System.UInt32" /> value (as a JSON number) as an element of a JSON array.</summary>
  1999. <param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
  2000. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  2001. </member>
  2002. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumberValue(System.UInt64)">
  2003. <summary>Writes a <see cref="T:System.UInt64" /> value (as a JSON number) as an element of a JSON array.</summary>
  2004. <param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
  2005. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  2006. </member>
  2007. <member name="M:System.Text.Json.Utf8JsonWriter.WritePropertyName(System.ReadOnlySpan{System.Byte})">
  2008. <summary>Writes the UTF-8 property name (as a JSON string) as the first part of a name/value pair of a JSON object.</summary>
  2009. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  2010. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2011. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2012. </member>
  2013. <member name="M:System.Text.Json.Utf8JsonWriter.WritePropertyName(System.ReadOnlySpan{System.Char})">
  2014. <summary>Writes the property name (as a JSON string) as the first part of a name/value pair of a JSON object.</summary>
  2015. <param name="propertyName">The property name of the JSON object to be transcoded and written as UTF-8.</param>
  2016. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2017. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2018. </member>
  2019. <member name="M:System.Text.Json.Utf8JsonWriter.WritePropertyName(System.String)">
  2020. <summary>Writes the property name (as a JSON string) as the first part of a name/value pair of a JSON object.</summary>
  2021. <param name="propertyName">The property name of the JSON object to be transcoded and written as UTF-8.</param>
  2022. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2023. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2024. <exception cref="T:System.ArgumentNullException">
  2025. <paramref name="propertyName" /> is <see langword="null" />.</exception>
  2026. </member>
  2027. <member name="M:System.Text.Json.Utf8JsonWriter.WritePropertyName(System.Text.Json.JsonEncodedText)">
  2028. <summary>Writes the pre-encoded property name (as a JSON string) as the first part of a name/value pair of a JSON object.</summary>
  2029. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2030. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2031. </member>
  2032. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStartArray">
  2033. <summary>Writes the beginning of a JSON array.</summary>
  2034. <exception cref="T:System.InvalidOperationException">The depth of the JSON exceeds the maximum depth of 1,000.
  2035. -or-
  2036. Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2037. </member>
  2038. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStartArray(System.ReadOnlySpan{System.Byte})">
  2039. <summary>Writes the beginning of a JSON array with a property name specified as a read-only span of bytes as the key.</summary>
  2040. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON array to be written.</param>
  2041. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2042. <exception cref="T:System.InvalidOperationException">The depth of the JSON exceeds the maximum depth of 1,000.
  2043. -or-
  2044. Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2045. </member>
  2046. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStartArray(System.ReadOnlySpan{System.Char})">
  2047. <summary>Writes the beginning of a JSON array with a property name specified as a read-only character span as the key.</summary>
  2048. <param name="propertyName">The UTF-16 encoded property name of the JSON array to be transcoded and written as UTF-8.</param>
  2049. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2050. <exception cref="T:System.InvalidOperationException">The depth of the JSON exceeds the maximum depth of 1,000.
  2051. -or-
  2052. Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2053. </member>
  2054. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStartArray(System.String)">
  2055. <summary>Writes the beginning of a JSON array with a property name specified as a string as the key.</summary>
  2056. <param name="propertyName">The UTF-16 encoded property name of the JSON array to be transcoded and written as UTF-8.</param>
  2057. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2058. <exception cref="T:System.InvalidOperationException">The depth of the JSON exceeds the maximum depth of 1,000.
  2059. -or-
  2060. Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2061. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2062. </member>
  2063. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStartArray(System.Text.Json.JsonEncodedText)">
  2064. <summary>Writes the beginning of a JSON array with a pre-encoded property name as the key.</summary>
  2065. <param name="propertyName">The JSON encoded property name of the JSON array to be transcoded and written as UTF-8.</param>
  2066. <exception cref="T:System.InvalidOperationException">The depth of the JSON has exceeded the maximum depth of 1,000.
  2067. -or-
  2068. Validation is enabled, and this method would result in writing invalid JSON.</exception>
  2069. </member>
  2070. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStartObject">
  2071. <summary>Writes the beginning of a JSON object.</summary>
  2072. <exception cref="T:System.InvalidOperationException">The depth of the JSON exceeds the maximum depth of 1,000.
  2073. -or-
  2074. Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  2075. </member>
  2076. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStartObject(System.ReadOnlySpan{System.Byte})">
  2077. <summary>Writes the beginning of a JSON object with a property name specified as a read-only span of bytes as the key.</summary>
  2078. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  2079. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2080. <exception cref="T:System.InvalidOperationException">The depth of the JSON exceeds the maximum depth of 1,000.
  2081. -or-
  2082. Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2083. </member>
  2084. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStartObject(System.ReadOnlySpan{System.Char})">
  2085. <summary>Writes the beginning of a JSON object with a property name specififed as a read-only character span as the key.</summary>
  2086. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2087. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2088. <exception cref="T:System.InvalidOperationException">The depth of the JSON exceeds the maximum depth of 1,000.
  2089. -or-
  2090. Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2091. </member>
  2092. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStartObject(System.String)">
  2093. <summary>Writes the beginning of a JSON object with a property name specified as a string as the key.</summary>
  2094. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2095. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2096. <exception cref="T:System.InvalidOperationException">The depth of the JSON exceeds the maximum depth of 1,000.
  2097. -or-
  2098. Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2099. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2100. </member>
  2101. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStartObject(System.Text.Json.JsonEncodedText)">
  2102. <summary>Writes the beginning of a JSON object with a pre-encoded property name as the key.</summary>
  2103. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2104. <exception cref="T:System.InvalidOperationException">The depth of the JSON has exceeded the maximum depth of 1,000.
  2105. -or-
  2106. Validation is enabled, and this method would result in writing invalid JSON.</exception>
  2107. </member>
  2108. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Byte},System.DateTime)">
  2109. <summary>Writes a UTF-8 property name and a <see cref="T:System.DateTime" /> value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2110. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  2111. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2112. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2113. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2114. </member>
  2115. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Byte},System.DateTimeOffset)">
  2116. <summary>Writes a UTF-8 property name and a <see cref="T:System.DateTimeOffset" /> value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2117. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  2118. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2119. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2120. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2121. </member>
  2122. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Byte},System.Guid)">
  2123. <summary>Writes a UTF-8 property name and a <see cref="T:System.Guid" /> value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2124. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  2125. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2126. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2127. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2128. </member>
  2129. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte})">
  2130. <summary>Writes a UTF-8 property name and UTF-8 text value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2131. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  2132. <param name="utf8Value">The UTF-8 encoded value to be written as a JSON string as part of the name/value pair.</param>
  2133. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  2134. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2135. </member>
  2136. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Char})">
  2137. <summary>Writes a UTF-8 property name and UTF-16 text value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2138. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  2139. <param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair.</param>
  2140. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  2141. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2142. </member>
  2143. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Byte},System.String)">
  2144. <summary>Writes a UTF-8 property name and string text value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2145. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  2146. <param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair.</param>
  2147. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  2148. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2149. </member>
  2150. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Byte},System.Text.Json.JsonEncodedText)">
  2151. <summary>Writes the UTF-8 property name and pre-encoded value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2152. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  2153. <param name="value">The JSON encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair.</param>
  2154. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2155. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  2156. </member>
  2157. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Char},System.DateTime)">
  2158. <summary>Writes a property name specified as a read-only character span and a <see cref="T:System.DateTime" /> value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2159. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2160. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2161. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2162. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2163. </member>
  2164. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Char},System.DateTimeOffset)">
  2165. <summary>Writes a property name specified as a read-only character span and a <see cref="T:System.DateTimeOffset" /> value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2166. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2167. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2168. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2169. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2170. </member>
  2171. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Char},System.Guid)">
  2172. <summary>Writes a property name specified as a read-only character span and a <see cref="T:System.Guid" /> value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2173. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2174. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2175. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2176. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2177. </member>
  2178. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Char},System.ReadOnlySpan{System.Byte})">
  2179. <summary>Writes a UTF-16 property name and UTF-8 text value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2180. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2181. <param name="utf8Value">The UTF-8 encoded value to be written as a JSON string as part of the name/value pair.</param>
  2182. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  2183. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2184. </member>
  2185. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Char},System.ReadOnlySpan{System.Char})">
  2186. <summary>Writes a UTF-16 property name and UTF-16 text value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2187. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2188. <param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair.</param>
  2189. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  2190. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2191. </member>
  2192. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Char},System.String)">
  2193. <summary>Writes a UTF-16 property name and string text value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2194. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2195. <param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair.</param>
  2196. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  2197. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2198. </member>
  2199. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Char},System.Text.Json.JsonEncodedText)">
  2200. <summary>Writes the property name and pre-encoded value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2201. <param name="propertyName">The property name of the JSON object to be transcoded and written as UTF-8.</param>
  2202. <param name="value">The JSON encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair.</param>
  2203. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2204. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2205. </member>
  2206. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.String,System.DateTime)">
  2207. <summary>Writes a property name specified as a string and a <see cref="T:System.DateTime" /> value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2208. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2209. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2210. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2211. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2212. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2213. </member>
  2214. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.String,System.DateTimeOffset)">
  2215. <summary>Writes a property name specified as a string and a <see cref="T:System.DateTimeOffset" /> value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2216. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2217. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2218. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2219. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2220. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2221. </member>
  2222. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.String,System.Guid)">
  2223. <summary>Writes a property name specified as a string and a <see cref="T:System.Guid" /> value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2224. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2225. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2226. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2227. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2228. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2229. </member>
  2230. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.String,System.ReadOnlySpan{System.Byte})">
  2231. <summary>Writes a property name specified as a string and a UTF-8 text value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2232. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2233. <param name="utf8Value">The UTF-8 encoded value to be written as a JSON string as part of the name/value pair.</param>
  2234. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  2235. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2236. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2237. </member>
  2238. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.String,System.ReadOnlySpan{System.Char})">
  2239. <summary>Writes a property name specified as a string and a UTF-16 text value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2240. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2241. <param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair.</param>
  2242. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  2243. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2244. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2245. </member>
  2246. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.String,System.String)">
  2247. <summary>Writes a property name specified as a string and a string text value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2248. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2249. <param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair.</param>
  2250. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  2251. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2252. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2253. </member>
  2254. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.String,System.Text.Json.JsonEncodedText)">
  2255. <summary>Writes the property name and pre-encoded value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2256. <param name="propertyName">The property name of the JSON object to be transcoded and written as UTF-8.</param>
  2257. <param name="value">The JSON encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair.</param>
  2258. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2259. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2260. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2261. </member>
  2262. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.Text.Json.JsonEncodedText,System.DateTime)">
  2263. <summary>Writes the pre-encoded property name and <see cref="T:System.DateTime" /> value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2264. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2265. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2266. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2267. </member>
  2268. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.Text.Json.JsonEncodedText,System.DateTimeOffset)">
  2269. <summary>Writes the pre-encoded property name and <see cref="T:System.DateTimeOffset" /> value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2270. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2271. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2272. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2273. </member>
  2274. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.Text.Json.JsonEncodedText,System.Guid)">
  2275. <summary>Writes the pre-encoded property name and <see cref="T:System.Guid" /> value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2276. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2277. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2278. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2279. </member>
  2280. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.Text.Json.JsonEncodedText,System.ReadOnlySpan{System.Byte})">
  2281. <summary>Writes the pre-encoded property name and UTF-8 text value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2282. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2283. <param name="utf8Value">The UTF-8 encoded value to be written as a JSON string as part of the name/value pair.</param>
  2284. <exception cref="T:System.ArgumentException">The specified value is too large.</exception>
  2285. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2286. </member>
  2287. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.Text.Json.JsonEncodedText,System.ReadOnlySpan{System.Char})">
  2288. <summary>Writes the pre-encoded property name and text value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2289. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2290. <param name="value">The value to be written as a UTF-8 transcoded JSON string as part of the name/value pair.</param>
  2291. <exception cref="T:System.ArgumentException">The specified value is too large.</exception>
  2292. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2293. </member>
  2294. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.Text.Json.JsonEncodedText,System.String)">
  2295. <summary>Writes the pre-encoded property name and string text value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2296. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2297. <param name="value">The value to be written as a UTF-8 transcoded JSON string as part of the name/value pair.</param>
  2298. <exception cref="T:System.ArgumentException">The specified value is too large.</exception>
  2299. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2300. </member>
  2301. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.Text.Json.JsonEncodedText,System.Text.Json.JsonEncodedText)">
  2302. <summary>Writes the pre-encoded property name and pre-encoded value (as a JSON string) as part of a name/value pair of a JSON object.</summary>
  2303. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2304. <param name="value">The JSON encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair.</param>
  2305. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2306. </member>
  2307. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStringValue(System.DateTime)">
  2308. <summary>Writes a <see cref="T:System.DateTime" /> value (as a JSON string) as an element of a JSON array.</summary>
  2309. <param name="value">The value to be written as a JSON string as an element of a JSON array.</param>
  2310. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  2311. </member>
  2312. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStringValue(System.DateTimeOffset)">
  2313. <summary>Writes a <see cref="T:System.DateTimeOffset" /> value (as a JSON string) as an element of a JSON array.</summary>
  2314. <param name="value">The value to be written as a JSON string as an element of a JSON array.</param>
  2315. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  2316. </member>
  2317. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStringValue(System.Guid)">
  2318. <summary>Writes a <see cref="T:System.Guid" /> value (as a JSON string) as an element of a JSON array.</summary>
  2319. <param name="value">The value to be written as a JSON string as an element of a JSON array.</param>
  2320. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  2321. </member>
  2322. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStringValue(System.ReadOnlySpan{System.Byte})">
  2323. <summary>Writes a UTF-8 text value (as a JSON string) as an element of a JSON array.</summary>
  2324. <param name="utf8Value">The UTF-8 encoded value to be written as a JSON string element of a JSON array.</param>
  2325. <exception cref="T:System.ArgumentException">The specified value is too large.</exception>
  2326. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2327. </member>
  2328. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStringValue(System.ReadOnlySpan{System.Char})">
  2329. <summary>Writes a UTF-16 text value (as a JSON string) as an element of a JSON array.</summary>
  2330. <param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array.</param>
  2331. <exception cref="T:System.ArgumentException">The specified value is too large.</exception>
  2332. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2333. </member>
  2334. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStringValue(System.String)">
  2335. <summary>Writes a string text value (as a JSON string) as an element of a JSON array.</summary>
  2336. <param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array.</param>
  2337. <exception cref="T:System.ArgumentException">The specified value is too large.</exception>
  2338. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2339. </member>
  2340. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStringValue(System.Text.Json.JsonEncodedText)">
  2341. <summary>Writes the pre-encoded text value (as a JSON string) as an element of a JSON array.</summary>
  2342. <param name="value">The JSON encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array.</param>
  2343. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2344. </member>
  2345. </members>
  2346. </doc>