System.Text.Json.xml 236 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661
  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. <exception cref="T:System.Text.Json.JsonException">
  30. <paramref name="utf8Json" /> does not represent a valid single JSON value.</exception>
  31. <exception cref="T:System.ArgumentException">
  32. <paramref name="options" /> contains unsupported options.</exception>
  33. <returns>A JsonDocument representation of the JSON value.</returns>
  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. <exception cref="T:System.Text.Json.JsonException">
  40. <paramref name="utf8Json" /> does not represent a valid single JSON value.</exception>
  41. <exception cref="T:System.ArgumentException">
  42. <paramref name="options" /> contains unsupported options.</exception>
  43. <returns>A JsonDocument representation of the JSON value.</returns>
  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. <exception cref="T:System.Text.Json.JsonException">
  50. <paramref name="utf8Json" /> does not represent a valid single JSON value.</exception>
  51. <exception cref="T:System.ArgumentException">
  52. <paramref name="options" /> contains unsupported options.</exception>
  53. <returns>A JsonDocument representation of the JSON value.</returns>
  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. <exception cref="T:System.Text.Json.JsonException">
  60. <paramref name="json" /> does not represent a valid single JSON value.</exception>
  61. <exception cref="T:System.ArgumentException">
  62. <paramref name="options" /> contains unsupported options.</exception>
  63. <returns>A JsonDocument representation of the JSON value.</returns>
  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. <exception cref="T:System.Text.Json.JsonException">
  70. <paramref name="json" /> does not represent a valid single JSON value.</exception>
  71. <exception cref="T:System.ArgumentException">
  72. <paramref name="options" /> contains unsupported options.</exception>
  73. <returns>A JsonDocument representation of the JSON value.</returns>
  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. <exception cref="T:System.Text.Json.JsonException">
  81. <paramref name="utf8Json" /> does not represent a valid single JSON value.</exception>
  82. <exception cref="T:System.ArgumentException">
  83. <paramref name="options" /> contains unsupported options.</exception>
  84. <returns>A task to produce a JsonDocument representation of the JSON value.</returns>
  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. <exception cref="T:System.ArgumentException">
  90. <paramref name="reader" /> contains unsupported options.
  91. -or-
  92. The current <paramref name="reader" /> token does not start or represent a value.</exception>
  93. <exception cref="T:System.Text.Json.JsonException">A value could not be read from the reader.</exception>
  94. <returns>A JsonDocument representing the value (and nested values) read from the reader.</returns>
  95. </member>
  96. <member name="M:System.Text.Json.JsonDocument.TryParseValue(System.Text.Json.Utf8JsonReader@,System.Text.Json.JsonDocument@)">
  97. <summary>Attempts to parse one JSON value (including objects or arrays) from the provided reader.</summary>
  98. <param name="reader">The reader to read.</param>
  99. <param name="document">When the method returns, contains the parsed document.</param>
  100. <exception cref="T:System.ArgumentException">
  101. <paramref name="reader" /> contains unsupported options.
  102. -or-
  103. The current <paramref name="reader" /> token does not start or represent a value.</exception>
  104. <exception cref="T:System.Text.Json.JsonException">A value could not be read from the reader.</exception>
  105. <returns>
  106. <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>
  107. </member>
  108. <member name="M:System.Text.Json.JsonDocument.WriteTo(System.Text.Json.Utf8JsonWriter)">
  109. <summary>Writes the document to the provided writer as a JSON value.</summary>
  110. <param name="writer">The writer to which to write the document.</param>
  111. <exception cref="T:System.ArgumentNullException">The <paramref name="writer" /> parameter is <see langword="null" />.</exception>
  112. <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>
  113. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  114. </member>
  115. <member name="P:System.Text.Json.JsonDocument.RootElement">
  116. <summary>Gets the root element of this JSON document.</summary>
  117. <returns>A <see cref="T:System.Text.Json.JsonElement" /> representing the value of the document.</returns>
  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. <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>
  130. <returns>One of the enumeration values that indicates how comments are handled.</returns>
  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. <exception cref="T:System.ArgumentOutOfRangeException">The max depth is set to a negative value.</exception>
  135. <returns>The maximum depth allowed when parsing JSON data.</returns>
  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="M:System.Text.Json.JsonElement.Clone">
  141. <summary>Gets a JsonElement that can be safely stored beyond the lifetime of the original <see cref="T:System.Text.Json.JsonDocument" />.</summary>
  142. <returns>A JsonElement that can be safely stored beyond the lifetime of the original <see cref="T:System.Text.Json.JsonDocument" />.</returns>
  143. </member>
  144. <member name="M:System.Text.Json.JsonElement.EnumerateArray">
  145. <summary>Gets an enumerator to enumerate the values in the JSON array represented by this JsonElement.</summary>
  146. <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>
  147. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  148. <returns>An enumerator to enumerate the values in the JSON array represented by this JsonElement.</returns>
  149. </member>
  150. <member name="M:System.Text.Json.JsonElement.EnumerateObject">
  151. <summary>Gets an enumerator to enumerate the properties in the JSON object represented by this JsonElement.</summary>
  152. <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>
  153. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  154. <returns>An enumerator to enumerate the properties in the JSON object represented by this JsonElement.</returns>
  155. </member>
  156. <member name="M:System.Text.Json.JsonElement.GetArrayLength">
  157. <summary>Gets the number of values contained within the current array value.</summary>
  158. <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>
  159. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  160. <returns>The number of values contained within the current array value.</returns>
  161. </member>
  162. <member name="M:System.Text.Json.JsonElement.GetBoolean">
  163. <summary>Gets the value of the element as a <see cref="T:System.Boolean" />.</summary>
  164. <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>
  165. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  166. <returns>The value of the element as a <see cref="T:System.Boolean" />.</returns>
  167. </member>
  168. <member name="M:System.Text.Json.JsonElement.GetByte">
  169. <summary>Gets the current JSON number as a <see cref="T:System.Byte" />.</summary>
  170. <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>
  171. <exception cref="T:System.FormatException">The value cannot be represented as a <see cref="T:System.Byte" />.</exception>
  172. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  173. <returns>The current JSON number as a <see cref="T:System.Byte" />.</returns>
  174. </member>
  175. <member name="M:System.Text.Json.JsonElement.GetBytesFromBase64">
  176. <summary>Gets the value of the element as a byte array.</summary>
  177. <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>
  178. <exception cref="T:System.FormatException">The value is not encoded as Base64 text and hence cannot be decoded to bytes.</exception>
  179. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  180. <returns>The value decoded as a byte array.</returns>
  181. </member>
  182. <member name="M:System.Text.Json.JsonElement.GetDateTime">
  183. <summary>Gets the value of the element as a <see cref="T:System.DateTime" />.</summary>
  184. <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>
  185. <exception cref="T:System.FormatException">The value cannot be read as a <see cref="T:System.DateTime" />.</exception>
  186. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  187. <returns>The value of the element as a <see cref="T:System.DateTime" />.</returns>
  188. </member>
  189. <member name="M:System.Text.Json.JsonElement.GetDateTimeOffset">
  190. <summary>Gets the value of the element as a <see cref="T:System.DateTimeOffset" />.</summary>
  191. <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>
  192. <exception cref="T:System.FormatException">The value cannot be read as a <see cref="T:System.DateTimeOffset" />.</exception>
  193. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  194. <returns>The value of the element as a <see cref="T:System.DateTimeOffset" />.</returns>
  195. </member>
  196. <member name="M:System.Text.Json.JsonElement.GetDecimal">
  197. <summary>Gets the current JSON number as a <see cref="T:System.Decimal" />.</summary>
  198. <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>
  199. <exception cref="T:System.FormatException">The value cannot be represented as a <see cref="T:System.Decimal" />.</exception>
  200. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  201. <returns>The current JSON number as a <see cref="T:System.Decimal" />.</returns>
  202. </member>
  203. <member name="M:System.Text.Json.JsonElement.GetDouble">
  204. <summary>Gets the current JSON number as a <see cref="T:System.Double" />.</summary>
  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.Double" />.</exception>
  207. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  208. <returns>The current JSON number as a <see cref="T:System.Double" />.</returns>
  209. </member>
  210. <member name="M:System.Text.Json.JsonElement.GetGuid">
  211. <summary>Gets the value of the element as a <see cref="T:System.Guid" />.</summary>
  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 cannot be represented as a <see cref="T:System.Guid" />.</exception>
  214. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  215. <returns>The value of the element as a <see cref="T:System.Guid" />.</returns>
  216. </member>
  217. <member name="M:System.Text.Json.JsonElement.GetInt16">
  218. <summary>Gets the current JSON number as an <see cref="T:System.Int16" />.</summary>
  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.Number" />.</exception>
  220. <exception cref="T:System.FormatException">The value cannot be represented as an <see cref="T:System.Int16" />.</exception>
  221. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  222. <returns>The current JSON number as an <see cref="T:System.Int16" />.</returns>
  223. </member>
  224. <member name="M:System.Text.Json.JsonElement.GetInt32">
  225. <summary>Gets the current JSON number as an <see cref="T:System.Int32" />.</summary>
  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.Number" />.</exception>
  227. <exception cref="T:System.FormatException">The value cannot be represented as an <see cref="T:System.Int32" />.</exception>
  228. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  229. <returns>The current JSON number as an <see cref="T:System.Int32" />.</returns>
  230. </member>
  231. <member name="M:System.Text.Json.JsonElement.GetInt64">
  232. <summary>Gets the current JSON number as an <see cref="T:System.Int64" />.</summary>
  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.Int64" />.</exception>
  235. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  236. <returns>The current JSON number as an <see cref="T:System.Int64" />.</returns>
  237. </member>
  238. <member name="M:System.Text.Json.JsonElement.GetProperty(System.ReadOnlySpan{System.Byte})">
  239. <summary>Gets a <see cref="T:System.Text.Json.JsonElement" /> representing the value of a required property identified by <paramref name="utf8PropertyName" />.</summary>
  240. <param name="utf8PropertyName">The UTF-8 representation (with no Byte-Order-Mark (BOM)) of the name of the property to return.</param>
  241. <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>
  242. <exception cref="T:System.Collections.Generic.KeyNotFoundException">No property was found with the requested name.</exception>
  243. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  244. <returns>A <see cref="T:System.Text.Json.JsonElement" /> representing the value of the requested property.</returns>
  245. </member>
  246. <member name="M:System.Text.Json.JsonElement.GetProperty(System.ReadOnlySpan{System.Char})">
  247. <summary>Gets a <see cref="T:System.Text.Json.JsonElement" /> representing the value of a required property identified by <paramref name="propertyName" />.</summary>
  248. <param name="propertyName">The name of the property whose value is to be returned.</param>
  249. <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>
  250. <exception cref="T:System.Collections.Generic.KeyNotFoundException">No property was found with the requested name.</exception>
  251. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  252. <returns>A <see cref="T:System.Text.Json.JsonElement" /> representing the value of the requested property.</returns>
  253. </member>
  254. <member name="M:System.Text.Json.JsonElement.GetProperty(System.String)">
  255. <summary>Gets a <see cref="T:System.Text.Json.JsonElement" /> representing the value of a required property identified by <paramref name="propertyName" />.</summary>
  256. <param name="propertyName">The name of the property whose value is to be returned.</param>
  257. <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>
  258. <exception cref="T:System.Collections.Generic.KeyNotFoundException">No property was found with the requested name.</exception>
  259. <exception cref="T:System.ArgumentNullException">
  260. <paramref name="propertyName" /> is <see langword="null" />.</exception>
  261. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  262. <returns>A <see cref="T:System.Text.Json.JsonElement" /> representing the value of the requested property.</returns>
  263. </member>
  264. <member name="M:System.Text.Json.JsonElement.GetRawText">
  265. <summary>Gets a string that represents the original input data backing this value.</summary>
  266. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  267. <returns>The original input data backing this value.</returns>
  268. </member>
  269. <member name="M:System.Text.Json.JsonElement.GetSByte">
  270. <summary>Gets the current JSON number as an <see cref="T:System.SByte" />.</summary>
  271. <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>
  272. <exception cref="T:System.FormatException">The value cannot be represented as an <see cref="T:System.SByte" />.</exception>
  273. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  274. <returns>The current JSON number as an <see cref="T:System.SByte" />.</returns>
  275. </member>
  276. <member name="M:System.Text.Json.JsonElement.GetSingle">
  277. <summary>Gets the current JSON number as a <see cref="T:System.Single" />.</summary>
  278. <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>
  279. <exception cref="T:System.FormatException">The value cannot be represented as a <see cref="T:System.Single" />.</exception>
  280. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  281. <returns>The current JSON number as a <see cref="T:System.Single" />.</returns>
  282. </member>
  283. <member name="M:System.Text.Json.JsonElement.GetString">
  284. <summary>Gets the value of the element as a <see cref="T:System.String" />.</summary>
  285. <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>
  286. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  287. <returns>The value of the element as a <see cref="T:System.String" />.</returns>
  288. </member>
  289. <member name="M:System.Text.Json.JsonElement.GetUInt16">
  290. <summary>Gets the current JSON number as a <see cref="T:System.UInt16" />.</summary>
  291. <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>
  292. <exception cref="T:System.FormatException">The value cannot be represented as a <see cref="T:System.UInt16" />.</exception>
  293. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  294. <returns>The current JSON number as a <see cref="T:System.UInt16" />.</returns>
  295. </member>
  296. <member name="M:System.Text.Json.JsonElement.GetUInt32">
  297. <summary>Gets the current JSON number as a <see cref="T:System.UInt32" />.</summary>
  298. <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>
  299. <exception cref="T:System.FormatException">The value cannot be represented as a <see cref="T:System.UInt32" />.</exception>
  300. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  301. <returns>The current JSON number as a <see cref="T:System.UInt32" />.</returns>
  302. </member>
  303. <member name="M:System.Text.Json.JsonElement.GetUInt64">
  304. <summary>Gets the current JSON number as a <see cref="T:System.UInt64" />.</summary>
  305. <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>
  306. <exception cref="T:System.FormatException">The value cannot be represented as a <see cref="T:System.UInt64" />.</exception>
  307. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  308. <returns>The current JSON number as a <see cref="T:System.UInt64" />.</returns>
  309. </member>
  310. <member name="M:System.Text.Json.JsonElement.ToString">
  311. <summary>Gets a string representation for the current value appropriate to the value type.</summary>
  312. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  313. <returns>A string representation for the current value appropriate to the value type.</returns>
  314. </member>
  315. <member name="M:System.Text.Json.JsonElement.TryGetByte(System.Byte@)">
  316. <summary>Attempts to represent the current JSON number as a <see cref="T:System.Byte" />.</summary>
  317. <param name="value">When the method returns, contains the byte equivalent of the current JSON number if the conversion succeeded.</param>
  318. <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>
  319. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  320. <returns>
  321. <see langword="true" /> if the number can be represented as a <see cref="T:System.Byte" />; otherwise, <see langword="false" />.</returns>
  322. </member>
  323. <member name="M:System.Text.Json.JsonElement.TryGetBytesFromBase64(System.Byte[]@)">
  324. <summary>Attempts to represent the current JSON string as a byte array, assuming that it is Base64 encoded.</summary>
  325. <param name="value">If the method succeeds, contains the decoded binary representation of the Base64 text.</param>
  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.String" />.</exception>
  327. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  328. <returns>
  329. <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>
  330. </member>
  331. <member name="M:System.Text.Json.JsonElement.TryGetDateTime(System.DateTime@)">
  332. <summary>Attempts to represent the current JSON string as a <see cref="T:System.DateTime" />.</summary>
  333. <param name="value">When this method returns, contains the date and time value equivalent to the current JSON string.</param>
  334. <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>
  335. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  336. <returns>
  337. <see langword="true" /> if the string can be represented as a <see cref="T:System.DateTime" />; otherwise, <see langword="false" />.</returns>
  338. </member>
  339. <member name="M:System.Text.Json.JsonElement.TryGetDateTimeOffset(System.DateTimeOffset@)">
  340. <summary>Attempts to represent the current JSON string as a <see cref="T:System.DateTimeOffset" />.</summary>
  341. <param name="value">When this method returns, contains the date and time equivalent to the current JSON string.</param>
  342. <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>
  343. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  344. <returns>
  345. <see langword="true" /> if the string can be represented as a <see cref="T:System.DateTimeOffset" />; otherwise, <see langword="false" />.</returns>
  346. </member>
  347. <member name="M:System.Text.Json.JsonElement.TryGetDecimal(System.Decimal@)">
  348. <summary>Attempts to represent the current JSON number as a <see cref="T:System.Decimal" />.</summary>
  349. <param name="value">When this method returns, contains the decimal equivalent of the current JSON number.</param>
  350. <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>
  351. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  352. <returns>
  353. <see langword="true" /> if the number can be represented as a <see cref="T:System.Decimal" />; otherwise, <see langword="false" />.</returns>
  354. </member>
  355. <member name="M:System.Text.Json.JsonElement.TryGetDouble(System.Double@)">
  356. <summary>Attempts to represent the current JSON number as a <see cref="T:System.Double" />.</summary>
  357. <param name="value">When this method returns, contains a double-precision floating point value equivalent to the current JSON number.</param>
  358. <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>
  359. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  360. <returns>
  361. <see langword="true" /> if the number can be represented as a <see cref="T:System.Double" />; otherwise, <see langword="false" />.</returns>
  362. </member>
  363. <member name="M:System.Text.Json.JsonElement.TryGetGuid(System.Guid@)">
  364. <summary>Attempts to represent the current JSON string as a <see cref="T:System.Guid" />.</summary>
  365. <param name="value">When this method returns, contains the GUID equivalent to the current JSON string.</param>
  366. <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>
  367. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  368. <returns>
  369. <see langword="true" /> if the string can be represented as a <see cref="T:System.Guid" />; otherwise, <see langword="false" />.</returns>
  370. </member>
  371. <member name="M:System.Text.Json.JsonElement.TryGetInt16(System.Int16@)">
  372. <summary>Attempts to represent the current JSON number as an <see cref="T:System.Int16" />.</summary>
  373. <param name="value">When the method returns, contains the 16-bit integer equivalent of the current JSON number if the conversion succeeded.</param>
  374. <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>
  375. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  376. <returns>
  377. <see langword="true" /> if the number can be represented as an <see cref="T:System.Int16" />; otherwise, <see langword="false" />.</returns>
  378. </member>
  379. <member name="M:System.Text.Json.JsonElement.TryGetInt32(System.Int32@)">
  380. <summary>Attempts to represent the current JSON number as an <see cref="T:System.Int32" />.</summary>
  381. <param name="value">When this method returns, contains the 32-biut integer value equivalent to the current JSON number.</param>
  382. <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>
  383. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  384. <returns>
  385. <see langword="true" /> if the number can be represented as an <see cref="T:System.Int32" />; otherwise, <see langword="false" />.</returns>
  386. </member>
  387. <member name="M:System.Text.Json.JsonElement.TryGetInt64(System.Int64@)">
  388. <summary>Attempts to represent the current JSON number as a <see cref="T:System.Int64" />.</summary>
  389. <param name="value">When this method returns, contains the 64-bit integer value equivalent to the current JSON number.</param>
  390. <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>
  391. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  392. <returns>
  393. <see langword="true" /> if the number can be represented as a <see cref="T:System.Int64" />; otherwise, <see langword="false" />.</returns>
  394. </member>
  395. <member name="M:System.Text.Json.JsonElement.TryGetProperty(System.ReadOnlySpan{System.Byte},System.Text.Json.JsonElement@)">
  396. <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>
  397. <param name="utf8PropertyName">The UTF-8 (with no Byte-Order-Mark (BOM)) representation of the name of the property to return.</param>
  398. <param name="value">Receives the value of the located property.</param>
  399. <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>
  400. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  401. <returns>
  402. <see langword="true" /> if the property was found; otherwise, <see langword="false" />.</returns>
  403. </member>
  404. <member name="M:System.Text.Json.JsonElement.TryGetProperty(System.ReadOnlySpan{System.Char},System.Text.Json.JsonElement@)">
  405. <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>
  406. <param name="propertyName">The name of the property to find.</param>
  407. <param name="value">When this method returns, contains the value of the specified property.</param>
  408. <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>
  409. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  410. <returns>
  411. <see langword="true" /> if the property was found; otherwise, <see langword="false" />.</returns>
  412. </member>
  413. <member name="M:System.Text.Json.JsonElement.TryGetProperty(System.String,System.Text.Json.JsonElement@)">
  414. <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>
  415. <param name="propertyName">The name of the property to find.</param>
  416. <param name="value">When this method returns, contains the value of the specified property.</param>
  417. <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>
  418. <exception cref="T:System.ArgumentNullException">
  419. <paramref name="propertyName" /> is <see langword="null" />.</exception>
  420. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  421. <returns>
  422. <see langword="true" /> if the property was found; otherwise, <see langword="false" />.</returns>
  423. </member>
  424. <member name="M:System.Text.Json.JsonElement.TryGetSByte(System.SByte@)">
  425. <summary>Attempts to represent the current JSON number as an <see cref="T:System.SByte" />.</summary>
  426. <param name="value">When the method returns, contains the signed byte equivalent of the current JSON number if the conversion succeeded.</param>
  427. <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>
  428. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  429. <returns>
  430. <see langword="true" /> if the number can be represented as an <see cref="T:System.SByte" />; otherwise, <see langword="false" />.</returns>
  431. </member>
  432. <member name="M:System.Text.Json.JsonElement.TryGetSingle(System.Single@)">
  433. <summary>Attempts to represent the current JSON number as a <see cref="T:System.Single" />.</summary>
  434. <param name="value">When this method returns, contains the single-precision floating point value equivalent to the current JSON number.</param>
  435. <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>
  436. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  437. <returns>
  438. <see langword="true" /> if the number can be represented as a <see cref="T:System.Single" />; otherwise, <see langword="false" />.</returns>
  439. </member>
  440. <member name="M:System.Text.Json.JsonElement.TryGetUInt16(System.UInt16@)">
  441. <summary>Attempts to represent the current JSON number as a <see cref="T:System.UInt16" />.</summary>
  442. <param name="value">When the method returns, contains the unsigned 16-bit integer equivalent of the current JSON number if the conversion succeeded.</param>
  443. <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>
  444. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  445. <returns>
  446. <see langword="true" /> if the number can be represented as a <see cref="T:System.UInt16" />; otherwise, <see langword="false" />.</returns>
  447. </member>
  448. <member name="M:System.Text.Json.JsonElement.TryGetUInt32(System.UInt32@)">
  449. <summary>Attempts to represent the current JSON number as a <see cref="T:System.UInt32" />.</summary>
  450. <param name="value">When this method returns, contains unsigned 32-bit integer value equivalent to the current JSON number.</param>
  451. <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>
  452. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  453. <returns>
  454. <see langword="true" /> if the number can be represented as a <see cref="T:System.UInt32" />; otherwise, <see langword="false" />.</returns>
  455. </member>
  456. <member name="M:System.Text.Json.JsonElement.TryGetUInt64(System.UInt64@)">
  457. <summary>Attempts to represent the current JSON number as a <see cref="T:System.UInt64" />.</summary>
  458. <param name="value">When this method returns, contains unsigned 64-bit integer value equivalent to the current JSON number.</param>
  459. <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>
  460. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  461. <returns>
  462. <see langword="true" /> if the number can be represented as a <see cref="T:System.UInt64" />; otherwise, <see langword="false" />.</returns>
  463. </member>
  464. <member name="M:System.Text.Json.JsonElement.ValueEquals(System.ReadOnlySpan{System.Byte})">
  465. <summary>Compares the text represented by a UTF8-encoded byte span to the string value of this element.</summary>
  466. <param name="utf8Text">The UTF-8 encoded text to compare against.</param>
  467. <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>
  468. <returns>
  469. <see langword="true" /> if the string value of this element has the same UTF-8 encoding as
  470. <paramref name="utf8Text" />; otherwise, <see langword="false" />.</returns>
  471. </member>
  472. <member name="M:System.Text.Json.JsonElement.ValueEquals(System.ReadOnlySpan{System.Char})">
  473. <summary>Compares a specified read-only character span to the string value of this element.</summary>
  474. <param name="text">The text to compare against.</param>
  475. <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>
  476. <returns>
  477. <see langword="true" /> if the string value of this element matches <paramref name="text" />; otherwise, <see langword="false" />.</returns>
  478. </member>
  479. <member name="M:System.Text.Json.JsonElement.ValueEquals(System.String)">
  480. <summary>Compares a specified string to the string value of this element.</summary>
  481. <param name="text">The text to compare against.</param>
  482. <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>
  483. <returns>
  484. <see langword="true" /> if the string value of this element matches <paramref name="text" />; otherwise, <see langword="false" />.</returns>
  485. </member>
  486. <member name="M:System.Text.Json.JsonElement.WriteTo(System.Text.Json.Utf8JsonWriter)">
  487. <summary>Writes the element to the specified writer as a JSON value.</summary>
  488. <param name="writer">The writer to which to write the element.</param>
  489. <exception cref="T:System.ArgumentNullException">The <paramref name="writer" /> parameter is <see langword="null" />.</exception>
  490. <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>
  491. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  492. </member>
  493. <member name="P:System.Text.Json.JsonElement.Item(System.Int32)">
  494. <summary>Gets the value at the specified index if the current value is an <see cref="F:System.Text.Json.JsonValueKind.Array" />.</summary>
  495. <param name="index">The item index.</param>
  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.Array" />.</exception>
  497. <exception cref="T:System.IndexOutOfRangeException">
  498. <paramref name="index" /> is not in the range [0, <see cref="M:System.Text.Json.JsonElement.GetArrayLength" />()).</exception>
  499. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  500. <returns>The value at the specified index.</returns>
  501. </member>
  502. <member name="P:System.Text.Json.JsonElement.ValueKind">
  503. <summary>Gets the type of the current JSON value.</summary>
  504. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  505. <returns>The type of the current JSON value.</returns>
  506. </member>
  507. <member name="T:System.Text.Json.JsonElement.ArrayEnumerator">
  508. <summary>Represents an enumerator for the contents of a JSON array.</summary>
  509. </member>
  510. <member name="M:System.Text.Json.JsonElement.ArrayEnumerator.Dispose">
  511. <summary>Releases the resources used by this <see cref="T:System.Text.Json.JsonElement.ArrayEnumerator" /> instance.</summary>
  512. </member>
  513. <member name="M:System.Text.Json.JsonElement.ArrayEnumerator.GetEnumerator">
  514. <summary>Returns an enumerator that iterates through a collection.</summary>
  515. <returns>An enumerator that can be used to iterate through the array.</returns>
  516. </member>
  517. <member name="M:System.Text.Json.JsonElement.ArrayEnumerator.MoveNext">
  518. <summary>Advances the enumerator to the next element of the collection.</summary>
  519. <returns>
  520. <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>
  521. </member>
  522. <member name="M:System.Text.Json.JsonElement.ArrayEnumerator.Reset">
  523. <summary>Sets the enumerator to its initial position, which is before the first element in the collection.</summary>
  524. </member>
  525. <member name="M:System.Text.Json.JsonElement.ArrayEnumerator.System#Collections#Generic#IEnumerable{System#Text#Json#JsonElement}#GetEnumerator">
  526. <summary>Returns an enumerator that iterates through a collection.</summary>
  527. <returns>An enumerator for an array of <see cref="T:System.Text.Json.JsonElement" /> that can be used to iterate through the collection.</returns>
  528. </member>
  529. <member name="M:System.Text.Json.JsonElement.ArrayEnumerator.System#Collections#IEnumerable#GetEnumerator">
  530. <summary>Returns an enumerator that iterates through a collection.</summary>
  531. <returns>An enumerator that can be used to iterate through the collection.</returns>
  532. </member>
  533. <member name="P:System.Text.Json.JsonElement.ArrayEnumerator.Current">
  534. <summary>Gets the element in the collection at the current position of the enumerator.</summary>
  535. <returns>The element in the collection at the current position of the enumerator.</returns>
  536. </member>
  537. <member name="P:System.Text.Json.JsonElement.ArrayEnumerator.System#Collections#IEnumerator#Current">
  538. <summary>Gets the element in the collection at the current position of the enumerator.</summary>
  539. <returns>The element in the collection at the current position of the enumerator.</returns>
  540. </member>
  541. <member name="T:System.Text.Json.JsonElement.ObjectEnumerator">
  542. <summary>Represents an enumerator for the properties of a JSON object.</summary>
  543. </member>
  544. <member name="M:System.Text.Json.JsonElement.ObjectEnumerator.Dispose">
  545. <summary>Releases the resources used by this <see cref="T:System.Text.Json.JsonElement.ObjectEnumerator" /> instance.</summary>
  546. </member>
  547. <member name="M:System.Text.Json.JsonElement.ObjectEnumerator.GetEnumerator">
  548. <summary>Returns an enumerator that iterates the properties of an object.</summary>
  549. <returns>An enumerator that can be used to iterate through the object.</returns>
  550. </member>
  551. <member name="M:System.Text.Json.JsonElement.ObjectEnumerator.MoveNext">
  552. <summary>Advances the enumerator to the next element of the collection.</summary>
  553. <returns>
  554. <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>
  555. </member>
  556. <member name="M:System.Text.Json.JsonElement.ObjectEnumerator.Reset">
  557. <summary>Sets the enumerator to its initial position, which is before the first element in the collection.</summary>
  558. </member>
  559. <member name="M:System.Text.Json.JsonElement.ObjectEnumerator.System#Collections#Generic#IEnumerable{System#Text#Json#JsonProperty}#GetEnumerator">
  560. <summary>Returns an enumerator that iterates through a collection.</summary>
  561. <returns>An enumerator for <see cref="T:System.Text.Json.JsonProperty" /> objects that can be used to iterate through the collection.</returns>
  562. </member>
  563. <member name="M:System.Text.Json.JsonElement.ObjectEnumerator.System#Collections#IEnumerable#GetEnumerator">
  564. <summary>Returns an enumerator that iterates through a collection.</summary>
  565. <returns>An enumerator that can be used to iterate through the collection.</returns>
  566. </member>
  567. <member name="P:System.Text.Json.JsonElement.ObjectEnumerator.Current">
  568. <summary>Gets the element in the collection at the current position of the enumerator.</summary>
  569. <returns>The element in the collection at the current position of the enumerator.</returns>
  570. </member>
  571. <member name="P:System.Text.Json.JsonElement.ObjectEnumerator.System#Collections#IEnumerator#Current">
  572. <summary>Gets the element in the collection at the current position of the enumerator.</summary>
  573. <returns>The element in the collection at the current position of the enumerator.</returns>
  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. <exception cref="T:System.ArgumentException">
  583. <paramref name="utf8Value" /> is too large.
  584. -or-
  585. <paramref name="utf8Value" /> contains invalid UTF-8 bytes.</exception>
  586. <returns>The encoded JSON text.</returns>
  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. <exception cref="T:System.ArgumentException">
  593. <paramref name="value" /> is too large.
  594. -or-
  595. <paramref name="value" /> contains invalid UTF-16 characters.</exception>
  596. <returns>The encoded JSON text.</returns>
  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. <exception cref="T:System.ArgumentNullException">
  603. <paramref name="value" /> is <see langword="null" />.</exception>
  604. <exception cref="T:System.ArgumentException">
  605. <paramref name="value" /> is too large.
  606. -or-
  607. <paramref name="value" /> contains invalid UTF-16 characters.</exception>
  608. <returns>The encoded JSON text.</returns>
  609. </member>
  610. <member name="M:System.Text.Json.JsonEncodedText.Equals(System.Object)">
  611. <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>
  612. <param name="obj">The object to compare to this instance.</param>
  613. <returns>
  614. <see langword="true" /> if the current instance and <paramref name="obj" /> are equal; otherwise, <see langword="false" />.</returns>
  615. </member>
  616. <member name="M:System.Text.Json.JsonEncodedText.Equals(System.Text.Json.JsonEncodedText)">
  617. <summary>Determines whether this instance and another specified <see cref="T:System.Text.Json.JsonEncodedText" /> instance have the same value.</summary>
  618. <param name="other">The object to compare to this instance.</param>
  619. <returns>
  620. <see langword="true" /> if this instance and <paramref name="other" /> have the same value; otherwise, <see langword="false" />.</returns>
  621. </member>
  622. <member name="M:System.Text.Json.JsonEncodedText.GetHashCode">
  623. <summary>Returns the hash code for this <see cref="T:System.Text.Json.JsonEncodedText" />.</summary>
  624. <returns>The hash code for this instance.</returns>
  625. </member>
  626. <member name="M:System.Text.Json.JsonEncodedText.ToString">
  627. <summary>Converts the value of this instance to a <see cref="T:System.String" />.</summary>
  628. <returns>The underlying UTF-16 encoded string.</returns>
  629. </member>
  630. <member name="P:System.Text.Json.JsonEncodedText.EncodedUtf8Bytes">
  631. <summary>Gets the UTF-8 encoded representation of the pre-encoded JSON text.</summary>
  632. <returns>The UTF-8 encoded representation of the pre-encoded JSON text.</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="M:System.Text.Json.JsonException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  672. <summary>Sets the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with information about the exception.</summary>
  673. <param name="info">The serialized object data about the exception being thrown.</param>
  674. <param name="context">An object that contains contextual information about the source or destination.</param>
  675. </member>
  676. <member name="P:System.Text.Json.JsonException.BytePositionInLine">
  677. <summary>Gets the zero-based number of bytes read within the current line before the exception.</summary>
  678. <returns>The zero-based number of bytes read within the current line before the exception.</returns>
  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="M:System.Text.Json.JsonNamingPolicy.ConvertName(System.String)">
  699. <summary>When overridden in a derived class, converts the specified name according to the policy.</summary>
  700. <param name="name">The name to convert.</param>
  701. <returns>The converted name.</returns>
  702. </member>
  703. <member name="P:System.Text.Json.JsonNamingPolicy.CamelCase">
  704. <summary>Gets the naming policy for camel-casing.</summary>
  705. <returns>The naming policy for camel-casing.</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="M:System.Text.Json.JsonProperty.NameEquals(System.ReadOnlySpan{System.Byte})">
  711. <summary>Compares the specified UTF-8 encoded text to the name of this property.</summary>
  712. <param name="utf8Text">The UTF-8 encoded text to compare against.</param>
  713. <exception cref="T:System.InvalidOperationException">This value's <see cref="T:System.Type" /> is not <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />.</exception>
  714. <returns>
  715. <see langword="true" /> if the name of this property has the same UTF-8 encoding as <paramref name="utf8Text" />; otherwise, <see langword="false" />.</returns>
  716. </member>
  717. <member name="M:System.Text.Json.JsonProperty.NameEquals(System.ReadOnlySpan{System.Char})">
  718. <summary>Compares the specified text as a character span to the name of this property.</summary>
  719. <param name="text">The text to compare against.</param>
  720. <exception cref="T:System.InvalidOperationException">This value's <see cref="T:System.Type" /> is not <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />.</exception>
  721. <returns>
  722. <see langword="true" /> if the name of this property matches <paramref name="text" />; otherwise, <see langword="false" />.</returns>
  723. </member>
  724. <member name="M:System.Text.Json.JsonProperty.NameEquals(System.String)">
  725. <summary>Compares the specified string to the name of this property.</summary>
  726. <param name="text">The text to compare against.</param>
  727. <exception cref="T:System.InvalidOperationException">This value's <see cref="T:System.Type" /> is not <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />.</exception>
  728. <returns>
  729. <see langword="true" /> if the name of this property matches <paramref name="text" />; otherwise <see langword="false" />.</returns>
  730. </member>
  731. <member name="M:System.Text.Json.JsonProperty.ToString">
  732. <summary>Provides a string representation of the property for debugging purposes.</summary>
  733. <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>
  734. </member>
  735. <member name="M:System.Text.Json.JsonProperty.WriteTo(System.Text.Json.Utf8JsonWriter)">
  736. <summary>Writes the property to the provided writer as a named JSON object property.</summary>
  737. <param name="writer">The writer to which to write the property.</param>
  738. <exception cref="T:System.ArgumentNullException">
  739. <paramref name="writer" /> is <see langword="null" />.</exception>
  740. <exception cref="T:System.ArgumentException">
  741. <see cref="P:System.Text.Json.JsonProperty.Name" /> is too large to be a JSON object property.</exception>
  742. <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>
  743. <exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
  744. </member>
  745. <member name="P:System.Text.Json.JsonProperty.Name">
  746. <summary>Gets the name of this property.</summary>
  747. <returns>The name of this property.</returns>
  748. </member>
  749. <member name="P:System.Text.Json.JsonProperty.Value">
  750. <summary>Gets the value of this property.</summary>
  751. <returns>The value of this property.</returns>
  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 extra 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. <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>
  764. <returns>One of the enumeration values that indicates how comments are handled.</returns>
  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. <exception cref="T:System.ArgumentOutOfRangeException">The maximum depth is being set to a negative value.</exception>
  769. <returns>The maximum depth allowed when reading JSON.</returns>
  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. <exception cref="T:System.ArgumentNullException">
  792. <paramref name="returnType" /> is <see langword="null" />.</exception>
  793. <exception cref="T:System.Text.Json.JsonException">The JSON is invalid.
  794. -or-
  795. <typeparamref name="returnType" /> is not compatible with the JSON.
  796. -or-
  797. There is remaining data in the span beyond a single JSON value.</exception>
  798. <exception cref="T:System.NotSupportedException">There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter" /> for <paramref name="returnType" /> or its serializable members.</exception>
  799. <returns>A <paramref name="returnType" /> representation of the JSON value.</returns>
  800. </member>
  801. <member name="M:System.Text.Json.JsonSerializer.Deserialize(System.String,System.Type,System.Text.Json.JsonSerializerOptions)">
  802. <summary>Parses the text representing a single JSON value into an instance of a specified type.</summary>
  803. <param name="json">The JSON text to parse.</param>
  804. <param name="returnType">The type of the object to convert to and return.</param>
  805. <param name="options">Options to control the behavior during parsing.</param>
  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. <exception cref="T:System.NotSupportedException">There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter" /> for <paramref name="returnType" /> or its serializable members.</exception>
  814. <returns>A <paramref name="returnType" /> representation of the JSON value.</returns>
  815. </member>
  816. <member name="M:System.Text.Json.JsonSerializer.Deserialize(System.Text.Json.Utf8JsonReader@,System.Type,System.Text.Json.JsonSerializerOptions)">
  817. <summary>Reads one JSON value (including objects or arrays) from the provided reader and converts it into an instance of a specified type.</summary>
  818. <param name="reader">The reader to read the JSON from.</param>
  819. <param name="returnType">The type of the object to convert to and return.</param>
  820. <param name="options">Options to control the serializer behavior during reading.</param>
  821. <exception cref="T:System.ArgumentNullException">
  822. <paramref name="returnType" /> is <see langword="null" />.</exception>
  823. <exception cref="T:System.Text.Json.JsonException">The JSON is invalid.
  824. -or-
  825. <typeparamref name="returnType" /> is not compatible with the JSON.
  826. -or-
  827. A value could not be read from the reader.</exception>
  828. <exception cref="T:System.ArgumentException">
  829. <paramref name="reader" /> is using unsupported options.</exception>
  830. <exception cref="T:System.NotSupportedException">There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter" /> for <paramref name="returnType" /> or its serializable members.</exception>
  831. <returns>A <paramref name="returnType" /> representation of the JSON value.</returns>
  832. </member>
  833. <member name="M:System.Text.Json.JsonSerializer.Deserialize``1(System.ReadOnlySpan{System.Byte},System.Text.Json.JsonSerializerOptions)">
  834. <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>
  835. <param name="utf8Json">The JSON text to parse.</param>
  836. <param name="options">Options to control the behavior during parsing.</param>
  837. <typeparam name="TValue">The target type of the UTF-8 encoded text.</typeparam>
  838. <exception cref="T:System.Text.Json.JsonException">The JSON is invalid.
  839. -or-
  840. <typeparamref name="TValue" /> is not compatible with the JSON.
  841. -or-
  842. There is remaining data in the span beyond a single JSON value.</exception>
  843. <exception cref="T:System.NotSupportedException">There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter" /> for <typeparamref name="TValue" /> or its serializable members.</exception>
  844. <returns>A <typeparamref name="TValue" /> representation of the JSON value.</returns>
  845. </member>
  846. <member name="M:System.Text.Json.JsonSerializer.Deserialize``1(System.String,System.Text.Json.JsonSerializerOptions)">
  847. <summary>Parses the text representing a single JSON value into an instance of the type specified by a generic type parameter.</summary>
  848. <param name="json">The JSON text to parse.</param>
  849. <param name="options">Options to control the behavior during parsing.</param>
  850. <typeparam name="TValue">The target type of the JSON value.</typeparam>
  851. <exception cref="T:System.ArgumentNullException">
  852. <paramref name="json" /> is <see langword="null" />.</exception>
  853. <exception cref="T:System.Text.Json.JsonException">The JSON is invalid.
  854. -or-
  855. <typeparamref name="TValue" /> is not compatible with the JSON.
  856. -or-
  857. There is remaining data in the string beyond a single JSON value.</exception>
  858. <exception cref="T:System.NotSupportedException">There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter" /> for <typeparamref name="TValue" /> or its serializable members.</exception>
  859. <returns>A <typeparamref name="TValue" /> representation of the JSON value.</returns>
  860. </member>
  861. <member name="M:System.Text.Json.JsonSerializer.Deserialize``1(System.Text.Json.Utf8JsonReader@,System.Text.Json.JsonSerializerOptions)">
  862. <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>
  863. <param name="reader">The reader to read the JSON from.</param>
  864. <param name="options">Options to control serializer behavior during reading.</param>
  865. <typeparam name="TValue">The target type of the JSON value.</typeparam>
  866. <exception cref="T:System.Text.Json.JsonException">The JSON is invalid.
  867. -or-
  868. <typeparamref name="TValue" /> is not compatible with the JSON.
  869. -or-
  870. A value could not be read from the reader.</exception>
  871. <exception cref="T:System.ArgumentException">
  872. <paramref name="reader" /> uses unsupported options.</exception>
  873. <exception cref="T:System.NotSupportedException">There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter" /> for <typeparamref name="TValue" /> or its serializable members.</exception>
  874. <returns>A <typeparamref name="TValue" /> representation of the JSON value.</returns>
  875. </member>
  876. <member name="M:System.Text.Json.JsonSerializer.DeserializeAsync(System.IO.Stream,System.Type,System.Text.Json.JsonSerializerOptions,System.Threading.CancellationToken)">
  877. <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>
  878. <param name="utf8Json">The JSON data to parse.</param>
  879. <param name="returnType">The type of the object to convert to and return.</param>
  880. <param name="options">Options to control the behavior during reading.</param>
  881. <param name="cancellationToken">A cancellation token that may be used to cancel the read operation.</param>
  882. <exception cref="T:System.ArgumentNullException">
  883. <paramref name="utf8Json" /> or <paramref name="returnType" /> is <see langword="null" />.</exception>
  884. <exception cref="T:System.Text.Json.JsonException">The JSON is invalid.
  885. -or-
  886. <typeparamref name="TValue" /> is not compatible with the JSON.
  887. -or-
  888. There is remaining data in the stream.</exception>
  889. <exception cref="T:System.NotSupportedException">There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter" /> for <paramref name="returnType" /> or its serializable members.</exception>
  890. <returns>A <paramref name="returnType" /> representation of the JSON value.</returns>
  891. </member>
  892. <member name="M:System.Text.Json.JsonSerializer.DeserializeAsync``1(System.IO.Stream,System.Text.Json.JsonSerializerOptions,System.Threading.CancellationToken)">
  893. <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>
  894. <param name="utf8Json">The JSON data to parse.</param>
  895. <param name="options">Options to control the behavior during reading.</param>
  896. <param name="cancellationToken">A token that may be used to cancel the read operation.</param>
  897. <typeparam name="TValue">The target type of the JSON value.</typeparam>
  898. <exception cref="T:System.Text.Json.JsonException">The JSON is invalid.
  899. -or-
  900. <typeparamref name="TValue" /> is not compatible with the JSON.
  901. -or-
  902. There is remaining data in the stream.</exception>
  903. <exception cref="T:System.NotSupportedException">There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter" /> for <typeparamref name="TValue" /> or its serializable members.</exception>
  904. <exception cref="T:System.ArgumentNullException">
  905. <paramref name="utf8Json" />is <see langword="null" />.</exception>
  906. <returns>A <typeparamref name="TValue" /> representation of the JSON value.</returns>
  907. </member>
  908. <member name="M:System.Text.Json.JsonSerializer.Serialize(System.Object,System.Type,System.Text.Json.JsonSerializerOptions)">
  909. <summary>Converts the value of a specified type into a JSON string.</summary>
  910. <param name="value">The value to convert.</param>
  911. <param name="inputType">The type of the <paramref name="value" /> to convert.</param>
  912. <param name="options">Options to control the conversion behavior.</param>
  913. <exception cref="T:System.ArgumentException">
  914. <paramref name="inputType" /> is not compatible with <paramref name="value" />.</exception>
  915. <exception cref="T:System.ArgumentNullException">
  916. <paramref name="inputType" /> is <see langword="null" />.</exception>
  917. <exception cref="T:System.NotSupportedException">There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter" /> for <paramref name="inputType" /> or its serializable members.</exception>
  918. <returns>The JSON string representation of the value.</returns>
  919. </member>
  920. <member name="M:System.Text.Json.JsonSerializer.Serialize(System.Text.Json.Utf8JsonWriter,System.Object,System.Type,System.Text.Json.JsonSerializerOptions)">
  921. <summary>Writes the JSON representation of the specified type to the provided writer.</summary>
  922. <param name="writer">The JSON writer to write to.</param>
  923. <param name="value">The value to convert and write.</param>
  924. <param name="inputType">The type of the <paramref name="value" /> to convert.</param>
  925. <param name="options">Options to control serialization behavior.</param>
  926. <exception cref="T:System.ArgumentException">
  927. <paramref name="inputType" /> is not compatible with <paramref name="value" /></exception>
  928. <exception cref="T:System.ArgumentNullException">
  929. <paramref name="writer" /> or <paramref name="inputType" /> is <see langword="null" />.</exception>
  930. <exception cref="T:System.NotSupportedException">There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter" /> for <paramref name="inputType" /> or its serializable members.</exception>
  931. </member>
  932. <member name="M:System.Text.Json.JsonSerializer.Serialize``1(``0,System.Text.Json.JsonSerializerOptions)">
  933. <summary>Converts the value of a type specified by a generic type parameter into a JSON string.</summary>
  934. <param name="value">The value to convert.</param>
  935. <param name="options">Options to control serialization behavior.</param>
  936. <typeparam name="TValue">The type of the value to serialize.</typeparam>
  937. <exception cref="T:System.NotSupportedException">There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter" /> for <typeparamref name="TValue" /> or its serializable members.</exception>
  938. <returns>A JSON string representation of the value.</returns>
  939. </member>
  940. <member name="M:System.Text.Json.JsonSerializer.Serialize``1(System.Text.Json.Utf8JsonWriter,``0,System.Text.Json.JsonSerializerOptions)">
  941. <summary>Writes the JSON representation of a type specified by a generic type parameter to the provided writer.</summary>
  942. <param name="writer">A JSON writer to write to.</param>
  943. <param name="value">The value to convert and write.</param>
  944. <param name="options">Options to control serialization behavior.</param>
  945. <typeparam name="TValue">The type of the value to serialize.</typeparam>
  946. <exception cref="T:System.ArgumentNullException">
  947. <paramref name="writer" /> is <see langword="null" />.</exception>
  948. <exception cref="T:System.NotSupportedException">There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter" /> for <typeparamref name="TValue" /> or its serializable members.</exception>
  949. </member>
  950. <member name="M:System.Text.Json.JsonSerializer.SerializeAsync(System.IO.Stream,System.Object,System.Type,System.Text.Json.JsonSerializerOptions,System.Threading.CancellationToken)">
  951. <summary>Asynchronously converts the value of a specified type to UTF-8 encoded JSON text and writes it to the specified stream.</summary>
  952. <param name="utf8Json">The UTF-8 stream to write to.</param>
  953. <param name="value">The value to convert.</param>
  954. <param name="inputType">The type of the <paramref name="value" /> to convert.</param>
  955. <param name="options">Options to control serialization behavior.</param>
  956. <param name="cancellationToken">A token that may be used to cancel the write operation.</param>
  957. <exception cref="T:System.ArgumentException">
  958. <paramref name="inputType" /> is not compatible with <paramref name="value" />.</exception>
  959. <exception cref="T:System.ArgumentNullException">
  960. <paramref name="utf8Json" /> or <paramref name="inputType" /> is <see langword="null" />.</exception>
  961. <exception cref="T:System.NotSupportedException">There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter" /> for <paramref name="inputType" /> or its serializable members.</exception>
  962. <returns>A task that represents the asynchronous write operation.</returns>
  963. </member>
  964. <member name="M:System.Text.Json.JsonSerializer.SerializeAsync``1(System.IO.Stream,``0,System.Text.Json.JsonSerializerOptions,System.Threading.CancellationToken)">
  965. <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>
  966. <param name="utf8Json">The UTF-8 stream to write to.</param>
  967. <param name="value">The value to convert.</param>
  968. <param name="options">Options to control serialization behavior.</param>
  969. <param name="cancellationToken">A token that may be used to cancel the write operation.</param>
  970. <typeparam name="TValue">The type of the value to serialize.</typeparam>
  971. <exception cref="T:System.ArgumentNullException">
  972. <paramref name="utf8Json" /> is <see langword="null" />.</exception>
  973. <exception cref="T:System.NotSupportedException">There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter" /> for <typeparamref name="TValue" /> or its serializable members.</exception>
  974. <returns>A task that represents the asynchronous write operation.</returns>
  975. </member>
  976. <member name="M:System.Text.Json.JsonSerializer.SerializeToUtf8Bytes(System.Object,System.Type,System.Text.Json.JsonSerializerOptions)">
  977. <summary>Converts a value of the specified type into a JSON string, encoded as UTF-8 bytes.</summary>
  978. <param name="value">The value to convert.</param>
  979. <param name="inputType">The type of the <paramref name="value" /> to convert.</param>
  980. <param name="options">Options to control the conversion behavior.</param>
  981. <exception cref="T:System.ArgumentException">
  982. <paramref name="inputType" /> is not compatible with <paramref name="value" />.</exception>
  983. <exception cref="T:System.ArgumentNullException">
  984. <paramref name="inputType" /> is <see langword="null" />.</exception>
  985. <exception cref="T:System.NotSupportedException">There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter" /> for <paramref name="inputType" /> or its serializable members.</exception>
  986. <returns>A JSON string representation of the value, encoded as UTF-8 bytes.</returns>
  987. </member>
  988. <member name="M:System.Text.Json.JsonSerializer.SerializeToUtf8Bytes``1(``0,System.Text.Json.JsonSerializerOptions)">
  989. <summary>Converts the value of a type specified by a generic type parameter into a JSON string, encoded as UTF-8 bytes.</summary>
  990. <param name="value">The value to convert.</param>
  991. <param name="options">Options to control the conversion behavior.</param>
  992. <typeparam name="TValue">The type of the value.</typeparam>
  993. <exception cref="T:System.NotSupportedException">There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter" /> for <typeparamref name="TValue" /> or its serializable members.</exception>
  994. <returns>A JSON string representation of the value, encoded as UTF-8 bytes.</returns>
  995. </member>
  996. <member name="T:System.Text.Json.JsonSerializerDefaults">
  997. <summary>Specifies what default options are used by <see cref="T:System.Text.Json.JsonSerializerOptions" />.</summary>
  998. </member>
  999. <member name="F:System.Text.Json.JsonSerializerDefaults.General">
  1000. <summary>Specifies that general-purpose values should be used. These are the same settings applied if a <see cref="T:System.Text.Json.JsonSerializerDefaults" /> isn't specified.</summary>
  1001. </member>
  1002. <member name="F:System.Text.Json.JsonSerializerDefaults.Web">
  1003. <summary>Specifies that values should be used more appropriate to web-based scenarios.</summary>
  1004. </member>
  1005. <member name="T:System.Text.Json.JsonSerializerOptions">
  1006. <summary>Provides options to be used with <see cref="T:System.Text.Json.JsonSerializer" />.</summary>
  1007. </member>
  1008. <member name="M:System.Text.Json.JsonSerializerOptions.#ctor">
  1009. <summary>Initializes a new instance of the <see cref="T:System.Text.Json.JsonSerializerOptions" /> class.</summary>
  1010. </member>
  1011. <member name="M:System.Text.Json.JsonSerializerOptions.#ctor(System.Text.Json.JsonSerializerDefaults)">
  1012. <summary>Constructs a new <see cref="T:System.Text.Json.JsonSerializerOptions" /> instance with a predefined set of options determined by the specified <see cref="T:System.Text.Json.JsonSerializerDefaults" />.</summary>
  1013. <param name="defaults">The <see cref="T:System.Text.Json.JsonSerializerDefaults" /> to reason about.</param>
  1014. </member>
  1015. <member name="M:System.Text.Json.JsonSerializerOptions.#ctor(System.Text.Json.JsonSerializerOptions)">
  1016. <summary>Copies the options from a <see cref="T:System.Text.Json.JsonSerializerOptions" /> instance to a new instance.</summary>
  1017. <param name="options">The options instance to copy options from.</param>
  1018. <exception cref="T:System.ArgumentNullException">
  1019. <paramref name="options" /> is <see langword="null" />.</exception>
  1020. </member>
  1021. <member name="M:System.Text.Json.JsonSerializerOptions.GetConverter(System.Type)">
  1022. <summary>Returns the converter for the specified type.</summary>
  1023. <param name="typeToConvert">The type to return a converter for.</param>
  1024. <exception cref="T:System.InvalidOperationException">The configured <see cref="System.Text.Json.Serialization.JsonConverter" /> for <paramref name="typeToConvert" /> returned an invalid converter.</exception>
  1025. <exception cref="T:System.NotSupportedException">There is no compatible <see cref="System.Text.Json.Serialization.JsonConverter" /> for <paramref name="typeToConvert" /> or its serializable members.</exception>
  1026. <returns>The first converter that supports the given type, or <see langword="null" /> if there is no converter.</returns>
  1027. </member>
  1028. <member name="P:System.Text.Json.JsonSerializerOptions.AllowTrailingCommas">
  1029. <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>
  1030. <exception cref="T:System.InvalidOperationException">This property was set after serialization or deserialization has occurred.</exception>
  1031. <returns>
  1032. <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>
  1033. </member>
  1034. <member name="P:System.Text.Json.JsonSerializerOptions.Converters">
  1035. <summary>Gets the list of user-defined converters that were registered.</summary>
  1036. <returns>The list of custom converters.</returns>
  1037. </member>
  1038. <member name="P:System.Text.Json.JsonSerializerOptions.DefaultBufferSize">
  1039. <summary>Gets or sets the default buffer size, in bytes, to use when creating temporary buffers.</summary>
  1040. <exception cref="T:System.ArgumentException">The buffer size is less than 1.</exception>
  1041. <exception cref="T:System.InvalidOperationException">This property was set after serialization or deserialization has occurred.</exception>
  1042. <returns>The default buffer size in bytes.</returns>
  1043. </member>
  1044. <member name="P:System.Text.Json.JsonSerializerOptions.DefaultIgnoreCondition">
  1045. <summary>Specifies a condition to determine when properties with default values are ignored during serialization or deserialization.
  1046. The default value is <see cref="F:System.Text.Json.Serialization.JsonIgnoreCondition.Never" />.</summary>
  1047. <exception cref="T:System.ArgumentException">This property is set to <see cref="F:System.Text.Json.Serialization.JsonIgnoreCondition.Always" />.</exception>
  1048. <exception cref="T:System.InvalidOperationException">This property is set after serialization or deserialization has occurred.
  1049. -or-
  1050. <see cref="P:System.Text.Json.JsonSerializerOptions.IgnoreNullValues" /> has been set to <see langword="true" />. These properties cannot be used together.</exception>
  1051. </member>
  1052. <member name="P:System.Text.Json.JsonSerializerOptions.DictionaryKeyPolicy">
  1053. <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>
  1054. <returns>The policy used to convert a <see cref="T:System.Collections.IDictionary" /> key's name to another format.</returns>
  1055. </member>
  1056. <member name="P:System.Text.Json.JsonSerializerOptions.Encoder">
  1057. <summary>Gets or sets the encoder to use when escaping strings, or <see langword="null" /> to use the default encoder.</summary>
  1058. <returns>The JavaScript character encoding.</returns>
  1059. </member>
  1060. <member name="P:System.Text.Json.JsonSerializerOptions.IgnoreNullValues">
  1061. <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>
  1062. <exception cref="T:System.InvalidOperationException">This property was set after serialization or deserialization has occurred.
  1063. -or-
  1064. <see cref="P:System.Text.Json.JsonSerializerOptions.DefaultIgnoreCondition" /> has been set to a non-default value. These properties cannot be used together.</exception>
  1065. <returns>
  1066. <see langword="true" /> to ignore null values during serialization and deserialization; otherwise, see langword="false" /&gt;.</returns>
  1067. </member>
  1068. <member name="P:System.Text.Json.JsonSerializerOptions.IgnoreReadOnlyFields">
  1069. <summary>Determines whether read-only fields are ignored during serialization. A property is read-only if it isn't marked with the <see langword="readonly" /> keyword. The default value is <see langword="false" />.</summary>
  1070. <exception cref="T:System.InvalidOperationException">This property is set after serialization or deserialization has occurred.</exception>
  1071. <returns>
  1072. <see langword="true" /> if read-only fields should be ignored during serialization; <see langword="false" /> otherwise.</returns>
  1073. </member>
  1074. <member name="P:System.Text.Json.JsonSerializerOptions.IgnoreReadOnlyProperties">
  1075. <summary>Gets a value that determines whether read-only properties are ignored during serialization. The default value is <see langword="false" />.</summary>
  1076. <exception cref="T:System.InvalidOperationException">This property was set after serialization or deserialization has occurred.</exception>
  1077. <returns>
  1078. <see langword="true" /> to ignore read-only properties during serialization; otherwise, <see langword="false" />.</returns>
  1079. </member>
  1080. <member name="P:System.Text.Json.JsonSerializerOptions.IncludeFields">
  1081. <summary>Determines whether fields are handled serialization and deserialization.
  1082. The default value is <see langword="false" />.</summary>
  1083. <exception cref="T:System.InvalidOperationException">This property is set after serialization or deserialization has occurred.</exception>
  1084. </member>
  1085. <member name="P:System.Text.Json.JsonSerializerOptions.MaxDepth">
  1086. <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>
  1087. <exception cref="T:System.InvalidOperationException">This property was set after serialization or deserialization has occurred.</exception>
  1088. <exception cref="T:System.ArgumentOutOfRangeException">The max depth is set to a negative value.</exception>
  1089. <returns>The maximum depth allowed when serializing or deserializing JSON.</returns>
  1090. </member>
  1091. <member name="P:System.Text.Json.JsonSerializerOptions.NumberHandling">
  1092. <summary>Specifies how number types should be handled when serializing or deserializing.</summary>
  1093. <exception cref="T:System.InvalidOperationException">This property is set after serialization or deserialization has occurred.</exception>
  1094. </member>
  1095. <member name="P:System.Text.Json.JsonSerializerOptions.PropertyNameCaseInsensitive">
  1096. <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>
  1097. <returns>
  1098. <see langword="true" /> to compare property names using case-insensitive comparison; otherwise, <see langword="false" />.</returns>
  1099. </member>
  1100. <member name="P:System.Text.Json.JsonSerializerOptions.PropertyNamingPolicy">
  1101. <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>
  1102. <returns>A property naming policy, or <see langword="null" /> to leave property names unchanged.</returns>
  1103. </member>
  1104. <member name="P:System.Text.Json.JsonSerializerOptions.ReadCommentHandling">
  1105. <summary>Gets or sets a value that defines how comments are handled during deserialization.</summary>
  1106. <exception cref="T:System.InvalidOperationException">This property was set after serialization or deserialization has occurred.</exception>
  1107. <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>
  1108. <returns>A value that indicates whether comments are allowed, disallowed, or skipped.</returns>
  1109. </member>
  1110. <member name="P:System.Text.Json.JsonSerializerOptions.ReferenceHandler">
  1111. <summary>Configures how object references are handled when reading and writing JSON.</summary>
  1112. </member>
  1113. <member name="P:System.Text.Json.JsonSerializerOptions.WriteIndented">
  1114. <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>
  1115. <exception cref="T:System.InvalidOperationException">This property was set after serialization or deserialization has occurred.</exception>
  1116. <returns>
  1117. <see langword="true" /> if JSON should pretty print on serialization; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
  1118. </member>
  1119. <member name="T:System.Text.Json.JsonTokenType">
  1120. <summary>Defines the various JSON tokens that make up a JSON text.</summary>
  1121. </member>
  1122. <member name="F:System.Text.Json.JsonTokenType.Comment">
  1123. <summary>The token type is a comment string.</summary>
  1124. </member>
  1125. <member name="F:System.Text.Json.JsonTokenType.EndArray">
  1126. <summary>The token type is the end of a JSON array.</summary>
  1127. </member>
  1128. <member name="F:System.Text.Json.JsonTokenType.EndObject">
  1129. <summary>The token type is the end of a JSON object.</summary>
  1130. </member>
  1131. <member name="F:System.Text.Json.JsonTokenType.False">
  1132. <summary>The token type is the JSON literal false.</summary>
  1133. </member>
  1134. <member name="F:System.Text.Json.JsonTokenType.None">
  1135. <summary>There is no value (as distinct from <see cref="F:System.Text.Json.JsonTokenType.Null" />).</summary>
  1136. </member>
  1137. <member name="F:System.Text.Json.JsonTokenType.Null">
  1138. <summary>The token type is the JSON literal null.</summary>
  1139. </member>
  1140. <member name="F:System.Text.Json.JsonTokenType.Number">
  1141. <summary>The token type is a JSON number.</summary>
  1142. </member>
  1143. <member name="F:System.Text.Json.JsonTokenType.PropertyName">
  1144. <summary>The token type is a JSON property name.</summary>
  1145. </member>
  1146. <member name="F:System.Text.Json.JsonTokenType.StartArray">
  1147. <summary>The token type is the start of a JSON array.</summary>
  1148. </member>
  1149. <member name="F:System.Text.Json.JsonTokenType.StartObject">
  1150. <summary>The token type is the start of a JSON object.</summary>
  1151. </member>
  1152. <member name="F:System.Text.Json.JsonTokenType.String">
  1153. <summary>The token type is a JSON string.</summary>
  1154. </member>
  1155. <member name="F:System.Text.Json.JsonTokenType.True">
  1156. <summary>The token type is the JSON literal true.</summary>
  1157. </member>
  1158. <member name="T:System.Text.Json.JsonValueKind">
  1159. <summary>Specifies the data type of a JSON value.</summary>
  1160. </member>
  1161. <member name="F:System.Text.Json.JsonValueKind.Array">
  1162. <summary>A JSON array.</summary>
  1163. </member>
  1164. <member name="F:System.Text.Json.JsonValueKind.False">
  1165. <summary>The JSON value false.</summary>
  1166. </member>
  1167. <member name="F:System.Text.Json.JsonValueKind.Null">
  1168. <summary>The JSON value null.</summary>
  1169. </member>
  1170. <member name="F:System.Text.Json.JsonValueKind.Number">
  1171. <summary>A JSON number.</summary>
  1172. </member>
  1173. <member name="F:System.Text.Json.JsonValueKind.Object">
  1174. <summary>A JSON object.</summary>
  1175. </member>
  1176. <member name="F:System.Text.Json.JsonValueKind.String">
  1177. <summary>A JSON string.</summary>
  1178. </member>
  1179. <member name="F:System.Text.Json.JsonValueKind.True">
  1180. <summary>The JSON value true.</summary>
  1181. </member>
  1182. <member name="F:System.Text.Json.JsonValueKind.Undefined">
  1183. <summary>There is no value (as distinct from <see cref="F:System.Text.Json.JsonValueKind.Null" />).</summary>
  1184. </member>
  1185. <member name="T:System.Text.Json.JsonWriterOptions">
  1186. <summary>Allows the user to define custom behavior when writing JSON using the <see cref="T:System.Text.Json.Utf8JsonWriter" />.</summary>
  1187. </member>
  1188. <member name="P:System.Text.Json.JsonWriterOptions.Encoder">
  1189. <summary>Gets or sets the encoder to use when escaping strings, or <see langword="null" /> to use the default encoder.</summary>
  1190. <returns>The JavaScript character encoder used to override the escaping behavior.</returns>
  1191. </member>
  1192. <member name="P:System.Text.Json.JsonWriterOptions.Indented">
  1193. <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>
  1194. <returns>
  1195. <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>
  1196. </member>
  1197. <member name="P:System.Text.Json.JsonWriterOptions.SkipValidation">
  1198. <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>
  1199. <returns>
  1200. <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>
  1201. </member>
  1202. <member name="T:System.Text.Json.Serialization.JsonAttribute">
  1203. <summary>Provides the base class for serialization attributes.</summary>
  1204. </member>
  1205. <member name="M:System.Text.Json.Serialization.JsonAttribute.#ctor">
  1206. <summary>Creates a new instance of the <see cref="T:System.Text.Json.Serialization.JsonAttribute" />.</summary>
  1207. </member>
  1208. <member name="T:System.Text.Json.Serialization.JsonConstructorAttribute">
  1209. <summary>When placed on a constructor, indicates that the constructor should be used to create instances of the type on deserialization.</summary>
  1210. </member>
  1211. <member name="M:System.Text.Json.Serialization.JsonConstructorAttribute.#ctor">
  1212. <summary>Initializes a new instance of <see cref="T:System.Text.Json.Serialization.JsonConstructorAttribute" />.</summary>
  1213. </member>
  1214. <member name="T:System.Text.Json.Serialization.JsonConverter">
  1215. <summary>Converts an object or value to or from JSON.</summary>
  1216. </member>
  1217. <member name="M:System.Text.Json.Serialization.JsonConverter.CanConvert(System.Type)">
  1218. <summary>When overridden in a derived class, determines whether the converter instance can convert the specified object type.</summary>
  1219. <param name="typeToConvert">The type of the object to check whether it can be converted by this converter instance.</param>
  1220. <returns>
  1221. <see langword="true" /> if the instance can convert the specified object type; otherwise, <see langword="false" />.</returns>
  1222. </member>
  1223. <member name="T:System.Text.Json.Serialization.JsonConverter`1">
  1224. <summary>Converts an object or value to or from JSON.</summary>
  1225. <typeparam name="T">The type of object or value handled by the converter.</typeparam>
  1226. </member>
  1227. <member name="M:System.Text.Json.Serialization.JsonConverter`1.#ctor">
  1228. <summary>Initializes a new <see cref="T:System.Text.Json.Serialization.JsonConverter`1" /> instance.</summary>
  1229. </member>
  1230. <member name="M:System.Text.Json.Serialization.JsonConverter`1.CanConvert(System.Type)">
  1231. <summary>Determines whether the specified type can be converted.</summary>
  1232. <param name="typeToConvert">The type to compare against.</param>
  1233. <returns>
  1234. <see langword="true" /> if the type can be converted; otherwise, <see langword="false" />.</returns>
  1235. </member>
  1236. <member name="M:System.Text.Json.Serialization.JsonConverter`1.Read(System.Text.Json.Utf8JsonReader@,System.Type,System.Text.Json.JsonSerializerOptions)">
  1237. <summary>Reads and converts the JSON to type <typeparamref name="T" />.</summary>
  1238. <param name="reader">The reader.</param>
  1239. <param name="typeToConvert">The type to convert.</param>
  1240. <param name="options">An object that specifies serialization options to use.</param>
  1241. <returns>The converted value.</returns>
  1242. </member>
  1243. <member name="M:System.Text.Json.Serialization.JsonConverter`1.Write(System.Text.Json.Utf8JsonWriter,`0,System.Text.Json.JsonSerializerOptions)">
  1244. <summary>Writes a specified value as JSON.</summary>
  1245. <param name="writer">The writer to write to.</param>
  1246. <param name="value">The value to convert to JSON.</param>
  1247. <param name="options">An object that specifies serialization options to use.</param>
  1248. </member>
  1249. <member name="P:System.Text.Json.Serialization.JsonConverter`1.HandleNull">
  1250. <summary>Indicates whether <see langword="null" /> should be passed to the converter on serialization, and whether <see cref="F:System.Text.Json.JsonTokenType.Null" /> should be passed on deserialization.</summary>
  1251. </member>
  1252. <member name="T:System.Text.Json.Serialization.JsonConverterAttribute">
  1253. <summary>When placed on a property or type, specifies the converter type to use.</summary>
  1254. </member>
  1255. <member name="M:System.Text.Json.Serialization.JsonConverterAttribute.#ctor">
  1256. <summary>Initializes a new instance of <see cref="T:System.Text.Json.Serialization.JsonConverterAttribute" />.</summary>
  1257. </member>
  1258. <member name="M:System.Text.Json.Serialization.JsonConverterAttribute.#ctor(System.Type)">
  1259. <summary>Initializes a new instance of <see cref="T:System.Text.Json.Serialization.JsonConverterAttribute" /> with the specified converter type.</summary>
  1260. <param name="converterType">The type of the converter.</param>
  1261. </member>
  1262. <member name="M:System.Text.Json.Serialization.JsonConverterAttribute.CreateConverter(System.Type)">
  1263. <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>
  1264. <param name="typeToConvert">The type of the converter.</param>
  1265. <returns>The custom converter.</returns>
  1266. </member>
  1267. <member name="P:System.Text.Json.Serialization.JsonConverterAttribute.ConverterType">
  1268. <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>
  1269. <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>
  1270. </member>
  1271. <member name="T:System.Text.Json.Serialization.JsonConverterFactory">
  1272. <summary>Supports converting several types by using a factory pattern.</summary>
  1273. </member>
  1274. <member name="M:System.Text.Json.Serialization.JsonConverterFactory.#ctor">
  1275. <summary>When overidden in a derived class, initializes a new instance of the <see cref="T:System.Text.Json.Serialization.JsonConverterFactory" /> class.</summary>
  1276. </member>
  1277. <member name="M:System.Text.Json.Serialization.JsonConverterFactory.CreateConverter(System.Type,System.Text.Json.JsonSerializerOptions)">
  1278. <summary>Creates a converter for a specified type.</summary>
  1279. <param name="typeToConvert">The type handled by the converter.</param>
  1280. <param name="options">The serialization options to use.</param>
  1281. <returns>A converter for which <typeparamref name="T" /> is compatible with <paramref name="typeToConvert" />.</returns>
  1282. </member>
  1283. <member name="T:System.Text.Json.Serialization.JsonExtensionDataAttribute">
  1284. <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>
  1285. </member>
  1286. <member name="M:System.Text.Json.Serialization.JsonExtensionDataAttribute.#ctor">
  1287. <summary>Instantiates a new instance of the <see cref="T:System.Text.Json.Serialization.JsonExtensionDataAttribute" /> class.</summary>
  1288. </member>
  1289. <member name="T:System.Text.Json.Serialization.JsonIgnoreAttribute">
  1290. <summary>Prevents a property from being serialized or deserialized.</summary>
  1291. </member>
  1292. <member name="M:System.Text.Json.Serialization.JsonIgnoreAttribute.#ctor">
  1293. <summary>Initializes a new instance of <see cref="T:System.Text.Json.Serialization.JsonIgnoreAttribute" />.</summary>
  1294. </member>
  1295. <member name="P:System.Text.Json.Serialization.JsonIgnoreAttribute.Condition">
  1296. <summary>Specifies the condition that must be met before a property will be ignored.</summary>
  1297. </member>
  1298. <member name="T:System.Text.Json.Serialization.JsonIgnoreCondition">
  1299. <summary>Controls how the <see cref="T:System.Text.Json.Serialization.JsonIgnoreAttribute" /> ignores properties on serialization and deserialization.</summary>
  1300. </member>
  1301. <member name="F:System.Text.Json.Serialization.JsonIgnoreCondition.Always">
  1302. <summary>Property will always be ignored.</summary>
  1303. </member>
  1304. <member name="F:System.Text.Json.Serialization.JsonIgnoreCondition.Never">
  1305. <summary>Property will always be serialized and deserialized, regardless of <see cref="P:System.Text.Json.JsonSerializerOptions.IgnoreNullValues" /> configuration.</summary>
  1306. </member>
  1307. <member name="F:System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingDefault">
  1308. <summary>Property will only be ignored if it is <see langword="null" />.</summary>
  1309. </member>
  1310. <member name="F:System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull">
  1311. <summary>If the value is <see langword="null" />, the property is ignored during serialization. This is applied only to reference-type properties and fields.</summary>
  1312. </member>
  1313. <member name="T:System.Text.Json.Serialization.JsonIncludeAttribute">
  1314. <summary>Indicates that the member should be included for serialization and deserialization.</summary>
  1315. <exception cref="T:System.InvalidOperationException">The attribute is applied to a non-public property.</exception>
  1316. </member>
  1317. <member name="M:System.Text.Json.Serialization.JsonIncludeAttribute.#ctor">
  1318. <summary>Initializes a new instance of <see cref="T:System.Text.Json.Serialization.JsonIncludeAttribute" />.</summary>
  1319. </member>
  1320. <member name="T:System.Text.Json.Serialization.JsonNumberHandling">
  1321. <summary>Determines how <see cref="T:System.Text.Json.JsonSerializer" /> handles numbers when serializing and deserializing.</summary>
  1322. </member>
  1323. <member name="F:System.Text.Json.Serialization.JsonNumberHandling.AllowNamedFloatingPointLiterals">
  1324. <summary>The "NaN", "Infinity", and "-Infinity" <see cref="F:System.Text.Json.JsonTokenType.String" /> tokens can be read as floating-point constants, and the <see cref="T:System.Single" /> and <see cref="T:System.Double" /> values for these constants will be written as their corresponding JSON string representations.</summary>
  1325. </member>
  1326. <member name="F:System.Text.Json.Serialization.JsonNumberHandling.AllowReadingFromString">
  1327. <summary>Numbers can be read from <see cref="F:System.Text.Json.JsonTokenType.String" /> tokens. Does not prevent numbers from being read from <see cref="F:System.Text.Json.JsonTokenType.Number" /> token.</summary>
  1328. </member>
  1329. <member name="F:System.Text.Json.Serialization.JsonNumberHandling.Strict">
  1330. <summary>Numbers will only be read from <see cref="F:System.Text.Json.JsonTokenType.Number" /> tokens and will only be written as JSON numbers (without quotes).</summary>
  1331. </member>
  1332. <member name="F:System.Text.Json.Serialization.JsonNumberHandling.WriteAsString">
  1333. <summary>Numbers will be written as JSON strings (with quotes), not as JSON numbers.</summary>
  1334. </member>
  1335. <member name="T:System.Text.Json.Serialization.JsonNumberHandlingAttribute">
  1336. <summary>When placed on a type, property, or field, indicates what <see cref="T:System.Text.Json.Serialization.JsonNumberHandling" /> settings should be used when serializing or deserializing numbers.</summary>
  1337. </member>
  1338. <member name="M:System.Text.Json.Serialization.JsonNumberHandlingAttribute.#ctor(System.Text.Json.Serialization.JsonNumberHandling)">
  1339. <summary>Initializes a new instance of <see cref="T:System.Text.Json.Serialization.JsonNumberHandlingAttribute" />.</summary>
  1340. <param name="handling">A bitwise combination of the enumeration values that specify how number types should be handled when serializing or deserializing.</param>
  1341. </member>
  1342. <member name="P:System.Text.Json.Serialization.JsonNumberHandlingAttribute.Handling">
  1343. <summary>Indicates what settings should be used when serializing or deserializing numbers.</summary>
  1344. <returns>An object that determines the number serialization and deserialization settings.</returns>
  1345. </member>
  1346. <member name="T:System.Text.Json.Serialization.JsonPropertyNameAttribute">
  1347. <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>
  1348. </member>
  1349. <member name="M:System.Text.Json.Serialization.JsonPropertyNameAttribute.#ctor(System.String)">
  1350. <summary>Initializes a new instance of <see cref="T:System.Text.Json.Serialization.JsonPropertyNameAttribute" /> with the specified property name.</summary>
  1351. <param name="name">The name of the property.</param>
  1352. </member>
  1353. <member name="P:System.Text.Json.Serialization.JsonPropertyNameAttribute.Name">
  1354. <summary>Gets the name of the property.</summary>
  1355. <returns>The name of the property.</returns>
  1356. </member>
  1357. <member name="T:System.Text.Json.Serialization.JsonStringEnumConverter">
  1358. <summary>Converts enumeration values to and from strings.</summary>
  1359. </member>
  1360. <member name="M:System.Text.Json.Serialization.JsonStringEnumConverter.#ctor">
  1361. <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>
  1362. </member>
  1363. <member name="M:System.Text.Json.Serialization.JsonStringEnumConverter.#ctor(System.Text.Json.JsonNamingPolicy,System.Boolean)">
  1364. <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>
  1365. <param name="namingPolicy">The optional naming policy for writing enum values.</param>
  1366. <param name="allowIntegerValues">
  1367. <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>
  1368. </member>
  1369. <member name="M:System.Text.Json.Serialization.JsonStringEnumConverter.CanConvert(System.Type)">
  1370. <summary>Determines whether the specified type can be converted to an enum.</summary>
  1371. <param name="typeToConvert">The type to be checked.</param>
  1372. <returns>
  1373. <see langword="true" /> if the type can be converted; otherwise, <see langword="false" />.</returns>
  1374. </member>
  1375. <member name="M:System.Text.Json.Serialization.JsonStringEnumConverter.CreateConverter(System.Type,System.Text.Json.JsonSerializerOptions)">
  1376. <summary>Creates a converter for the specified type.</summary>
  1377. <param name="typeToConvert">The type handled by the converter.</param>
  1378. <param name="options">The serialization options to use.</param>
  1379. <returns>A converter for which <typeparamref name="T" /> is compatible with <paramref name="typeToConvert" />.</returns>
  1380. </member>
  1381. <member name="T:System.Text.Json.Serialization.ReferenceHandler">
  1382. <summary>This class defines how the <see cref="T:System.Text.Json.JsonSerializer" /> deals with references on serialization and deserialization.</summary>
  1383. </member>
  1384. <member name="M:System.Text.Json.Serialization.ReferenceHandler.#ctor">
  1385. <summary>Initializes a new instance of the <see cref="T:System.Text.Json.Serialization.ReferenceHandler" /> class.</summary>
  1386. </member>
  1387. <member name="M:System.Text.Json.Serialization.ReferenceHandler.CreateResolver">
  1388. <summary>Returns the <see cref="T:System.Text.Json.Serialization.ReferenceResolver" /> used for each serialization call.</summary>
  1389. <returns>The resolver to use for serialization and deserialization.</returns>
  1390. </member>
  1391. <member name="P:System.Text.Json.Serialization.ReferenceHandler.Preserve">
  1392. <summary>Metadata properties will be honored when deserializing JSON objects and arrays into reference types and written when serializing reference types. This is necessary to create round-trippable JSON from objects that contain cycles or duplicate references.</summary>
  1393. </member>
  1394. <member name="T:System.Text.Json.Serialization.ReferenceHandler`1">
  1395. <summary>This class defines how the <see cref="T:System.Text.Json.JsonSerializer" /> deals with references on serialization and deserialization.</summary>
  1396. <typeparam name="T">The type of the <see cref="T:System.Text.Json.Serialization.ReferenceResolver" /> to create on each serialization or deserialization call.</typeparam>
  1397. </member>
  1398. <member name="M:System.Text.Json.Serialization.ReferenceHandler`1.#ctor">
  1399. <summary>Initializes a new instance of the <see cref="T:System.Text.Json.Serialization.ReferenceHandler`1" /> generic class that can create a <see cref="T:System.Text.Json.Serialization.ReferenceResolver" /> instance of the specified <typeparam name="T" />.</summary>
  1400. </member>
  1401. <member name="M:System.Text.Json.Serialization.ReferenceHandler`1.CreateResolver">
  1402. <summary>Creates a new <see cref="T:System.Text.Json.Serialization.ReferenceResolver" /> of type <typeparamref name="T" /> used for each serialization call.</summary>
  1403. <returns>The new resolver to use for serialization and deserialization.</returns>
  1404. </member>
  1405. <member name="T:System.Text.Json.Serialization.ReferenceResolver">
  1406. <summary>This class defines how the <see cref="T:System.Text.Json.JsonSerializer" /> deals with references on serialization and deserialization.
  1407. Defines the core behavior of preserving references on serialization and deserialization.</summary>
  1408. </member>
  1409. <member name="M:System.Text.Json.Serialization.ReferenceResolver.#ctor">
  1410. <summary>Initializes a new instance of the <see cref="T:System.Text.Json.Serialization.ReferenceResolver" /> class.</summary>
  1411. </member>
  1412. <member name="M:System.Text.Json.Serialization.ReferenceResolver.AddReference(System.String,System.Object)">
  1413. <summary>Adds an entry to the bag of references using the specified id and value.
  1414. This method gets called when an $id metadata property from a JSON object is read.</summary>
  1415. <param name="referenceId">The identifier of the JSON object or array.</param>
  1416. <param name="value">The value of the CLR reference type object that results from parsing the JSON object.</param>
  1417. </member>
  1418. <member name="M:System.Text.Json.Serialization.ReferenceResolver.GetReference(System.Object,System.Boolean@)">
  1419. <summary>Gets the reference identifier of the specified value if exists; otherwise a new id is assigned.
  1420. This method gets called before a CLR object is written so we can decide whether to write $id and enumerate the rest of its properties or $ref and step into the next object.</summary>
  1421. <param name="value">The value of the CLR reference type object to get an id for.</param>
  1422. <param name="alreadyExists">When this method returns, <see langword="true" /> if a reference to value already exists; otherwise, <see langword="false" />.</param>
  1423. <returns>The reference id for the specified object.</returns>
  1424. </member>
  1425. <member name="M:System.Text.Json.Serialization.ReferenceResolver.ResolveReference(System.String)">
  1426. <summary>Returns the CLR reference type object related to the specified reference id.
  1427. This method gets called when $ref metadata property is read.</summary>
  1428. <param name="referenceId">The reference id related to the returned object.</param>
  1429. <returns>The reference type object related to the specified reference id.</returns>
  1430. </member>
  1431. <member name="T:System.Text.Json.Utf8JsonReader">
  1432. <summary>Provides a high-performance API for forward-only, read-only access to UTF-8 encoded JSON text.</summary>
  1433. </member>
  1434. <member name="M:System.Text.Json.Utf8JsonReader.#ctor(System.Buffers.ReadOnlySequence{System.Byte},System.Boolean,System.Text.Json.JsonReaderState)">
  1435. <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>
  1436. <param name="jsonData">The UTF-8 encoded JSON text to process.</param>
  1437. <param name="isFinalBlock">
  1438. <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>
  1439. <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>
  1440. </member>
  1441. <member name="M:System.Text.Json.Utf8JsonReader.#ctor(System.Buffers.ReadOnlySequence{System.Byte},System.Text.Json.JsonReaderOptions)">
  1442. <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>
  1443. <param name="jsonData">The UTF-8 encoded JSON text to process.</param>
  1444. <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>
  1445. </member>
  1446. <member name="M:System.Text.Json.Utf8JsonReader.#ctor(System.ReadOnlySpan{System.Byte},System.Boolean,System.Text.Json.JsonReaderState)">
  1447. <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>
  1448. <param name="jsonData">The UTF-8 encoded JSON text to process.</param>
  1449. <param name="isFinalBlock">
  1450. <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>
  1451. <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>
  1452. </member>
  1453. <member name="M:System.Text.Json.Utf8JsonReader.#ctor(System.ReadOnlySpan{System.Byte},System.Text.Json.JsonReaderOptions)">
  1454. <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>
  1455. <param name="jsonData">The UTF-8 encoded JSON text to process.</param>
  1456. <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>
  1457. </member>
  1458. <member name="M:System.Text.Json.Utf8JsonReader.GetBoolean">
  1459. <summary>Reads the next JSON token value from the source as a <see cref="T:System.Boolean" />.</summary>
  1460. <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>
  1461. <returns>
  1462. <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>
  1463. </member>
  1464. <member name="M:System.Text.Json.Utf8JsonReader.GetByte">
  1465. <summary>Parses the current JSON token value from the source as a <see cref="T:System.Byte" />.</summary>
  1466. <exception cref="T:System.InvalidOperationException">The value of the JSON token is not a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1467. <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).
  1468. -or-
  1469. 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>
  1470. <returns>The value of the UTF-8 encoded token.</returns>
  1471. </member>
  1472. <member name="M:System.Text.Json.Utf8JsonReader.GetBytesFromBase64">
  1473. <summary>Parses the current JSON token value from the source and decodes the Base64 encoded JSON string as a byte array.</summary>
  1474. <exception cref="T:System.InvalidOperationException">The type of the JSON token is not a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
  1475. <exception cref="T:System.FormatException">The value is not encoded as Base64 text, so it can't be decoded to bytes.
  1476. -or-
  1477. The value contains invalid or more than two padding characters.
  1478. -or-
  1479. The value is incomplete. That is, the JSON string length is not a multiple of 4.</exception>
  1480. <returns>The byte array that represents the current JSON token value.</returns>
  1481. </member>
  1482. <member name="M:System.Text.Json.Utf8JsonReader.GetComment">
  1483. <summary>Parses the current JSON token value from the source as a comment, transcoded it as a <see cref="T:System.String" />.</summary>
  1484. <exception cref="T:System.InvalidOperationException">The JSON token is not a comment.</exception>
  1485. <returns>The comment that represents the current JSON token value.</returns>
  1486. </member>
  1487. <member name="M:System.Text.Json.Utf8JsonReader.GetDateTime">
  1488. <summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.DateTime" />.</summary>
  1489. <exception cref="T:System.InvalidOperationException">The value of the JSON token isn't a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
  1490. <exception cref="T:System.FormatException">The JSON token value cannot be read as a <see cref="T:System.DateTime" />.
  1491. -or-
  1492. The entire UTF-8 encoded token value cannot be parsed to a <see cref="T:System.DateTime" /> value.
  1493. -or-
  1494. The JSON token value is of an unsupported format.</exception>
  1495. <returns>The date and time value, if the entire UTF-8 encoded token value can be successfully parsed.</returns>
  1496. </member>
  1497. <member name="M:System.Text.Json.Utf8JsonReader.GetDateTimeOffset">
  1498. <summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.DateTimeOffset" />.</summary>
  1499. <exception cref="T:System.InvalidOperationException">The value of the JSON token isn't a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
  1500. <exception cref="T:System.FormatException">The JSON token value cannot be read as a <see cref="T:System.DateTimeOffset" />.
  1501. -or-
  1502. The entire UTF-8 encoded token value cannot be parsed to a <see cref="T:System.DateTimeOffset" /> value.
  1503. -or-
  1504. The JSON token value is of an unsupported format.</exception>
  1505. <returns>The date and time offset, if the entire UTF-8 encoded token value can be successfully parsed.</returns>
  1506. </member>
  1507. <member name="M:System.Text.Json.Utf8JsonReader.GetDecimal">
  1508. <summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.Decimal" />.</summary>
  1509. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1510. <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>
  1511. <returns>The UTF-8 encoded token value parsed to a <see cref="T:System.Decimal" />.</returns>
  1512. </member>
  1513. <member name="M:System.Text.Json.Utf8JsonReader.GetDouble">
  1514. <summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.Double" />.</summary>
  1515. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1516. <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>
  1517. <returns>The UTF-8 encoded token value parsed to a <see cref="T:System.Double" />.</returns>
  1518. </member>
  1519. <member name="M:System.Text.Json.Utf8JsonReader.GetGuid">
  1520. <summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.Guid" />.</summary>
  1521. <exception cref="T:System.InvalidOperationException">The value of the JSON token isn't a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
  1522. <exception cref="T:System.FormatException">The JSON token value is in an unsupported format for a Guid.
  1523. -or-
  1524. The entire UTF-8 encoded token value cannot be parsed to a <see cref="T:System.Guid" /> value.</exception>
  1525. <returns>The GUID value, if the entire UTF-8 encoded token value can be successfully parsed.</returns>
  1526. </member>
  1527. <member name="M:System.Text.Json.Utf8JsonReader.GetInt16">
  1528. <summary>Parses the current JSON token value from the source as a <see cref="T:System.Int16" />.</summary>
  1529. <exception cref="T:System.InvalidOperationException">The value of the JSON token is not a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1530. <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).
  1531. -or-
  1532. 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>
  1533. <returns>The UTF-8 encoded token value parsed to an <see cref="T:System.Int16" />.</returns>
  1534. </member>
  1535. <member name="M:System.Text.Json.Utf8JsonReader.GetInt32">
  1536. <summary>Reads the next JSON token value from the source and parses it to an <see cref="T:System.Int32" />.</summary>
  1537. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1538. <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.
  1539. -or-
  1540. 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>
  1541. <returns>The UTF-8 encoded token value parsed to an <see cref="T:System.Int32" />.</returns>
  1542. </member>
  1543. <member name="M:System.Text.Json.Utf8JsonReader.GetInt64">
  1544. <summary>Reads the next JSON token value from the source and parses it to an <see cref="T:System.Int64" />.</summary>
  1545. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1546. <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.
  1547. -or-
  1548. 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>
  1549. <returns>The UTF-8 encoded token value parsed to an <see cref="T:System.Int64" />.</returns>
  1550. </member>
  1551. <member name="M:System.Text.Json.Utf8JsonReader.GetSByte">
  1552. <summary>Parses the current JSON token value from the source as an <see cref="T:System.SByte" />.</summary>
  1553. <exception cref="T:System.InvalidOperationException">The value of the JSON token is not a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1554. <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).
  1555. -or-
  1556. 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>
  1557. <returns>The UTF-8 encoded token value parsed to an <see cref="T:System.SByte" />.</returns>
  1558. </member>
  1559. <member name="M:System.Text.Json.Utf8JsonReader.GetSingle">
  1560. <summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.Single" />.</summary>
  1561. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1562. <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>
  1563. <returns>The UTF-8 encoded token value parsed to a <see cref="T:System.Single" />.</returns>
  1564. </member>
  1565. <member name="M:System.Text.Json.Utf8JsonReader.GetString">
  1566. <summary>Reads the next JSON token value from the source, unescaped, and transcoded as a string.</summary>
  1567. <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" />).
  1568. -or-
  1569. The JSON string contains invalid UTF-8 bytes or invalid UTF-16 surrogates.</exception>
  1570. <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>
  1571. </member>
  1572. <member name="M:System.Text.Json.Utf8JsonReader.GetUInt16">
  1573. <summary>Parses the current JSON token value from the source as a <see cref="T:System.UInt16" />.</summary>
  1574. <exception cref="T:System.InvalidOperationException">The value of the JSON token is not a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1575. <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).
  1576. -or-
  1577. 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>
  1578. <returns>The UTF-8 encoded token value parsed to a <see cref="T:System.UInt16" />.</returns>
  1579. </member>
  1580. <member name="M:System.Text.Json.Utf8JsonReader.GetUInt32">
  1581. <summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.UInt32" />.</summary>
  1582. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1583. <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.
  1584. -or-
  1585. 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>
  1586. <returns>The UTF-8 encoded token value parsed to a <see cref="T:System.UInt32" />.</returns>
  1587. </member>
  1588. <member name="M:System.Text.Json.Utf8JsonReader.GetUInt64">
  1589. <summary>Reads the next JSON token value from the source and parses it to a <see cref="T:System.UInt64" />.</summary>
  1590. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1591. <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.
  1592. -or-
  1593. 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>
  1594. <returns>The UTF-8 encoded token value parsed to a <see cref="T:System.UInt64" />.</returns>
  1595. </member>
  1596. <member name="M:System.Text.Json.Utf8JsonReader.Read">
  1597. <summary>Reads the next JSON token from the input source.</summary>
  1598. <exception cref="T:System.Text.Json.JsonException">An invalid JSON token according to the JSON RFC is encountered.
  1599. -or-
  1600. The current depth exceeds the recursive limit set by the maximum depth.</exception>
  1601. <returns>
  1602. <see langword="true" /> if the token was read successfully; otherwise, <see langword="false" />.</returns>
  1603. </member>
  1604. <member name="M:System.Text.Json.Utf8JsonReader.Skip">
  1605. <summary>Skips the children of the current JSON token.</summary>
  1606. <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>
  1607. <exception cref="T:System.Text.Json.JsonException">An invalid JSON token was encountered while skipping, according to the JSON RFC.
  1608. -or-
  1609. The current depth exceeds the recursive limit set by the maximum depth.</exception>
  1610. </member>
  1611. <member name="M:System.Text.Json.Utf8JsonReader.TryGetByte(System.Byte@)">
  1612. <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>
  1613. <param name="value">When this method returns, contains the parsed value.</param>
  1614. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1615. <returns>
  1616. <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>
  1617. </member>
  1618. <member name="M:System.Text.Json.Utf8JsonReader.TryGetBytesFromBase64(System.Byte[]@)">
  1619. <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>
  1620. <param name="value">When this method returns, contains the decoded binary representation of the Base64 text.</param>
  1621. <exception cref="T:System.InvalidOperationException">The JSON token is not a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
  1622. <returns>
  1623. <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>
  1624. </member>
  1625. <member name="M:System.Text.Json.Utf8JsonReader.TryGetDateTime(System.DateTime@)">
  1626. <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>
  1627. <param name="value">When this method returns, contains the parsed value.</param>
  1628. <exception cref="T:System.InvalidOperationException">The value of the JSON token isn't a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
  1629. <returns>
  1630. <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>
  1631. </member>
  1632. <member name="M:System.Text.Json.Utf8JsonReader.TryGetDateTimeOffset(System.DateTimeOffset@)">
  1633. <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>
  1634. <param name="value">When this method returns, contains the parsed value.</param>
  1635. <exception cref="T:System.InvalidOperationException">The value of the JSON token isn't a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
  1636. <returns>
  1637. <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>
  1638. </member>
  1639. <member name="M:System.Text.Json.Utf8JsonReader.TryGetDecimal(System.Decimal@)">
  1640. <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>
  1641. <param name="value">When this method returns, contains the parsed value.</param>
  1642. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1643. <returns>
  1644. <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>
  1645. </member>
  1646. <member name="M:System.Text.Json.Utf8JsonReader.TryGetDouble(System.Double@)">
  1647. <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>
  1648. <param name="value">When this method returns, contains the parsed value.</param>
  1649. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1650. <returns>
  1651. <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>
  1652. </member>
  1653. <member name="M:System.Text.Json.Utf8JsonReader.TryGetGuid(System.Guid@)">
  1654. <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>
  1655. <param name="value">When this method returns, contains the parsed value.</param>
  1656. <exception cref="T:System.InvalidOperationException">The value of the JSON token isn't a <see cref="F:System.Text.Json.JsonTokenType.String" />.</exception>
  1657. <returns>
  1658. <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>
  1659. </member>
  1660. <member name="M:System.Text.Json.Utf8JsonReader.TryGetInt16(System.Int16@)">
  1661. <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>
  1662. <param name="value">When this method returns, contains the parsed value.</param>
  1663. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1664. <returns>
  1665. <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>
  1666. </member>
  1667. <member name="M:System.Text.Json.Utf8JsonReader.TryGetInt32(System.Int32@)">
  1668. <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>
  1669. <param name="value">When this method returns, contains the parsed value.</param>
  1670. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1671. <returns>
  1672. <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>
  1673. </member>
  1674. <member name="M:System.Text.Json.Utf8JsonReader.TryGetInt64(System.Int64@)">
  1675. <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>
  1676. <param name="value">When this method returns, contains the parsed value.</param>
  1677. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1678. <returns>
  1679. <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>
  1680. </member>
  1681. <member name="M:System.Text.Json.Utf8JsonReader.TryGetSByte(System.SByte@)">
  1682. <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>
  1683. <param name="value">When this method returns, contains the parsed value.</param>
  1684. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1685. <returns>
  1686. <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>
  1687. </member>
  1688. <member name="M:System.Text.Json.Utf8JsonReader.TryGetSingle(System.Single@)">
  1689. <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>
  1690. <param name="value">When this method returns, contains the parsed value.</param>
  1691. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1692. <returns>
  1693. <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>
  1694. </member>
  1695. <member name="M:System.Text.Json.Utf8JsonReader.TryGetUInt16(System.UInt16@)">
  1696. <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>
  1697. <param name="value">When this method returns, contains the parsed value.</param>
  1698. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1699. <returns>
  1700. <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>
  1701. </member>
  1702. <member name="M:System.Text.Json.Utf8JsonReader.TryGetUInt32(System.UInt32@)">
  1703. <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>
  1704. <param name="value">When this method returns, contains the parsed value.</param>
  1705. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1706. <returns>
  1707. <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>
  1708. </member>
  1709. <member name="M:System.Text.Json.Utf8JsonReader.TryGetUInt64(System.UInt64@)">
  1710. <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>
  1711. <param name="value">When this method returns, contains the parsed value.</param>
  1712. <exception cref="T:System.InvalidOperationException">The JSON token value isn't a <see cref="F:System.Text.Json.JsonTokenType.Number" />.</exception>
  1713. <returns>
  1714. <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>
  1715. </member>
  1716. <member name="M:System.Text.Json.Utf8JsonReader.TrySkip">
  1717. <summary>Tries to skip the children of the current JSON token.</summary>
  1718. <exception cref="T:System.Text.Json.JsonException">An invalid JSON token was encountered while skipping, according to the JSON RFC.
  1719. -or -
  1720. The current depth exceeds the recursive limit set by the maximum depth.</exception>
  1721. <returns>
  1722. <see langword="true" /> if there was enough data for the children to be skipped successfully; otherwise, <see langword="false" />.</returns>
  1723. </member>
  1724. <member name="M:System.Text.Json.Utf8JsonReader.ValueTextEquals(System.ReadOnlySpan{System.Byte})">
  1725. <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>
  1726. <param name="utf8Text">The UTF-8 encoded text to compare against.</param>
  1727. <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>
  1728. <returns>
  1729. <see langword="true" /> if the JSON token value in the source matches the UTF-8 encoded lookup text; otherwise, <see langword="false" />.</returns>
  1730. </member>
  1731. <member name="M:System.Text.Json.Utf8JsonReader.ValueTextEquals(System.ReadOnlySpan{System.Char})">
  1732. <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>
  1733. <param name="text">The text to compare against.</param>
  1734. <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>
  1735. <returns>
  1736. <see langword="true" /> if the JSON token value in the source matches the lookup text; otherwise, <see langword="false" />.</returns>
  1737. </member>
  1738. <member name="M:System.Text.Json.Utf8JsonReader.ValueTextEquals(System.String)">
  1739. <summary>Compares the string text to the unescaped JSON token value in the source and returns a value that indicates whether they match.</summary>
  1740. <param name="text">The text to compare against.</param>
  1741. <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>
  1742. <returns>
  1743. <see langword="true" /> if the JSON token value in the source matches the lookup text; otherwise, <see langword="false" />.</returns>
  1744. </member>
  1745. <member name="P:System.Text.Json.Utf8JsonReader.BytesConsumed">
  1746. <summary>Gets the total number of bytes consumed so far by this instance of the <see cref="T:System.Text.Json.Utf8JsonReader" />.</summary>
  1747. <returns>The total number of bytes consumed so far.</returns>
  1748. </member>
  1749. <member name="P:System.Text.Json.Utf8JsonReader.CurrentDepth">
  1750. <summary>Gets the depth of the current token.</summary>
  1751. <returns>The depth of the current token.</returns>
  1752. </member>
  1753. <member name="P:System.Text.Json.Utf8JsonReader.CurrentState">
  1754. <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>
  1755. <returns>The current reader state.</returns>
  1756. </member>
  1757. <member name="P:System.Text.Json.Utf8JsonReader.HasValueSequence">
  1758. <summary>Gets a value that indicates which <c>Value</c> property to use to get the token value.</summary>
  1759. <returns>
  1760. <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>
  1761. </member>
  1762. <member name="P:System.Text.Json.Utf8JsonReader.IsFinalBlock">
  1763. <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>
  1764. <returns>
  1765. <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>
  1766. </member>
  1767. <member name="P:System.Text.Json.Utf8JsonReader.Position">
  1768. <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>
  1769. <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>
  1770. </member>
  1771. <member name="P:System.Text.Json.Utf8JsonReader.TokenStartIndex">
  1772. <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>
  1773. <returns>The starting index of the last processed JSON token within the given UTF-8 encoded input text.</returns>
  1774. </member>
  1775. <member name="P:System.Text.Json.Utf8JsonReader.TokenType">
  1776. <summary>Gets the type of the last processed JSON token in the UTF-8 encoded JSON text.</summary>
  1777. <returns>The type of the last processed JSON token.</returns>
  1778. </member>
  1779. <member name="P:System.Text.Json.Utf8JsonReader.ValueSequence">
  1780. <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>
  1781. <returns>A byte read-only sequence.</returns>
  1782. </member>
  1783. <member name="P:System.Text.Json.Utf8JsonReader.ValueSpan">
  1784. <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>
  1785. <returns>A read-only span of bytes.</returns>
  1786. </member>
  1787. <member name="T:System.Text.Json.Utf8JsonWriter">
  1788. <summary>Provides a high-performance API for forward-only, non-cached writing of UTF-8 encoded JSON text.</summary>
  1789. </member>
  1790. <member name="M:System.Text.Json.Utf8JsonWriter.#ctor(System.Buffers.IBufferWriter{System.Byte},System.Text.Json.JsonWriterOptions)">
  1791. <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>
  1792. <param name="bufferWriter">The destination for writing JSON text.</param>
  1793. <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>
  1794. <exception cref="T:System.ArgumentNullException">
  1795. <paramref name="bufferWriter" /> is <see langword="null" />.</exception>
  1796. </member>
  1797. <member name="M:System.Text.Json.Utf8JsonWriter.#ctor(System.IO.Stream,System.Text.Json.JsonWriterOptions)">
  1798. <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>
  1799. <param name="utf8Json">The destination for writing JSON text.</param>
  1800. <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>
  1801. <exception cref="T:System.ArgumentNullException">
  1802. <paramref name="utf8Json" /> is <see langword="null" />.</exception>
  1803. </member>
  1804. <member name="M:System.Text.Json.Utf8JsonWriter.Dispose">
  1805. <summary>Commits any leftover JSON text that has not yet been flushed and releases all resources used by the current instance.</summary>
  1806. </member>
  1807. <member name="M:System.Text.Json.Utf8JsonWriter.DisposeAsync">
  1808. <summary>Asynchronously commits any leftover JSON text that has not yet been flushed and releases all resources used by the current instance.</summary>
  1809. <returns>A task representing the asynchronous dispose operation.</returns>
  1810. </member>
  1811. <member name="M:System.Text.Json.Utf8JsonWriter.Flush">
  1812. <summary>Commits the JSON text written so far, which makes it visible to the output destination.</summary>
  1813. <exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
  1814. </member>
  1815. <member name="M:System.Text.Json.Utf8JsonWriter.FlushAsync(System.Threading.CancellationToken)">
  1816. <summary>Asynchronously commits the JSON text written so far, which makes it visible to the output destination.</summary>
  1817. <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
  1818. <exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
  1819. <returns>A task representing the asynchronous flush operation.</returns>
  1820. </member>
  1821. <member name="M:System.Text.Json.Utf8JsonWriter.Reset">
  1822. <summary>Resets the internal state of this instance so that it can be reused.</summary>
  1823. <exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
  1824. </member>
  1825. <member name="M:System.Text.Json.Utf8JsonWriter.Reset(System.Buffers.IBufferWriter{System.Byte})">
  1826. <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>
  1827. <param name="bufferWriter">The destination for writing JSON text.</param>
  1828. <exception cref="T:System.ArgumentNullException">
  1829. <paramref name="bufferWriter" /> is <see langword="null" />.</exception>
  1830. <exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
  1831. </member>
  1832. <member name="M:System.Text.Json.Utf8JsonWriter.Reset(System.IO.Stream)">
  1833. <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>
  1834. <param name="utf8Json">The destination for writing JSON text.</param>
  1835. <exception cref="T:System.ArgumentNullException">
  1836. <paramref name="utf8Json" /> is <see langword="null" />.</exception>
  1837. <exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
  1838. </member>
  1839. <member name="M:System.Text.Json.Utf8JsonWriter.WriteBase64String(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte})">
  1840. <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>
  1841. <param name="utf8PropertyName">The UTF-8 encoded name of the property to write.</param>
  1842. <param name="bytes">The binary data to write as Base64 encoded text.</param>
  1843. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  1844. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  1845. </member>
  1846. <member name="M:System.Text.Json.Utf8JsonWriter.WriteBase64String(System.ReadOnlySpan{System.Char},System.ReadOnlySpan{System.Byte})">
  1847. <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>
  1848. <param name="propertyName">The property name of the JSON object to be transcoded and written as UTF-8.</param>
  1849. <param name="bytes">The binary data to write as Base64 encoded text.</param>
  1850. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  1851. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  1852. </member>
  1853. <member name="M:System.Text.Json.Utf8JsonWriter.WriteBase64String(System.String,System.ReadOnlySpan{System.Byte})">
  1854. <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>
  1855. <param name="propertyName">The property name of the JSON object to be transcoded and written as UTF-8.</param>
  1856. <param name="bytes">The binary data to write as Base64 encoded text.</param>
  1857. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  1858. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  1859. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  1860. </member>
  1861. <member name="M:System.Text.Json.Utf8JsonWriter.WriteBase64String(System.Text.Json.JsonEncodedText,System.ReadOnlySpan{System.Byte})">
  1862. <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>
  1863. <param name="propertyName">The JSON-encoded name of the property to write.</param>
  1864. <param name="bytes">The binary data to write as Base64 encoded text.</param>
  1865. <exception cref="T:System.ArgumentException">The specified value is too large.</exception>
  1866. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  1867. </member>
  1868. <member name="M:System.Text.Json.Utf8JsonWriter.WriteBase64StringValue(System.ReadOnlySpan{System.Byte})">
  1869. <summary>Writes the raw bytes value as a Base64 encoded JSON string as an element of a JSON array.</summary>
  1870. <param name="bytes">The binary data to be written as a Base64 encoded JSON string element of a JSON array.</param>
  1871. <exception cref="T:System.ArgumentException">The specified value is too large.</exception>
  1872. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  1873. </member>
  1874. <member name="M:System.Text.Json.Utf8JsonWriter.WriteBoolean(System.ReadOnlySpan{System.Byte},System.Boolean)">
  1875. <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>
  1876. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  1877. <param name="value">The value to be written as a JSON literal true or false 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 operation would result in writing invalid JSON.</exception>
  1880. </member>
  1881. <member name="M:System.Text.Json.Utf8JsonWriter.WriteBoolean(System.ReadOnlySpan{System.Char},System.Boolean)">
  1882. <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>
  1883. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1884. <param name="value">The value to be written as a JSON literal true or false as part of the name/value pair.</param>
  1885. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1886. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  1887. </member>
  1888. <member name="M:System.Text.Json.Utf8JsonWriter.WriteBoolean(System.String,System.Boolean)">
  1889. <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>
  1890. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1891. <param name="value">The value to be written as a JSON literal true or false as part of the name/value pair.</param>
  1892. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1893. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  1894. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  1895. </member>
  1896. <member name="M:System.Text.Json.Utf8JsonWriter.WriteBoolean(System.Text.Json.JsonEncodedText,System.Boolean)">
  1897. <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>
  1898. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1899. <param name="value">The value to be written as a JSON literal true or false as part of the name/value pair.</param>
  1900. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  1901. </member>
  1902. <member name="M:System.Text.Json.Utf8JsonWriter.WriteBooleanValue(System.Boolean)">
  1903. <summary>Writes a <see cref="T:System.Boolean" /> value (as a JSON literal true or false) as an element of a JSON array.</summary>
  1904. <param name="value">The value to be written as a JSON literal true or false as an element of a JSON array.</param>
  1905. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  1906. </member>
  1907. <member name="M:System.Text.Json.Utf8JsonWriter.WriteCommentValue(System.ReadOnlySpan{System.Byte})">
  1908. <summary>Writes a UTF-8 text value as a JSON comment.</summary>
  1909. <param name="utf8Value">The UTF-8 encoded value to be written as a JSON comment within <c>/*..*/</c>.</param>
  1910. <exception cref="T:System.ArgumentException">The specified value is too large.
  1911. -or-
  1912. <paramref name="utf8Value" /> contains a comment delimiter (that is, <c>*/</c>).</exception>
  1913. </member>
  1914. <member name="M:System.Text.Json.Utf8JsonWriter.WriteCommentValue(System.ReadOnlySpan{System.Char})">
  1915. <summary>Writes a UTF-16 text value as a JSON comment.</summary>
  1916. <param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within <c>/*..*/</c>.</param>
  1917. <exception cref="T:System.ArgumentException">The specified value is too large.
  1918. -or-
  1919. <paramref name="value" /> contains a comment delimiter (that is, <c>*/</c>).</exception>
  1920. </member>
  1921. <member name="M:System.Text.Json.Utf8JsonWriter.WriteCommentValue(System.String)">
  1922. <summary>Writes a string text value as a JSON comment.</summary>
  1923. <param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within <c>/*..*/</c>.</param>
  1924. <exception cref="T:System.ArgumentException">The specified value is too large.
  1925. -or-
  1926. <paramref name="value" /> contains a comment delimiter (that is, <c>*/</c>).</exception>
  1927. <exception cref="T:System.ArgumentNullException">The <paramref name="value" /> parameter is <see langword="null" />.</exception>
  1928. </member>
  1929. <member name="M:System.Text.Json.Utf8JsonWriter.WriteEndArray">
  1930. <summary>Writes the end of a JSON array.</summary>
  1931. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  1932. </member>
  1933. <member name="M:System.Text.Json.Utf8JsonWriter.WriteEndObject">
  1934. <summary>Writes the end of a JSON object.</summary>
  1935. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  1936. </member>
  1937. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNull(System.ReadOnlySpan{System.Byte})">
  1938. <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>
  1939. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  1940. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1941. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1942. </member>
  1943. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNull(System.ReadOnlySpan{System.Char})">
  1944. <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>
  1945. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1946. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1947. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1948. </member>
  1949. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNull(System.String)">
  1950. <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>
  1951. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1952. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1953. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1954. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  1955. </member>
  1956. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNull(System.Text.Json.JsonEncodedText)">
  1957. <summary>Writes the pre-encoded property name and the JSON literal null as part of a name/value pair of a JSON object.</summary>
  1958. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  1959. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  1960. </member>
  1961. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNullValue">
  1962. <summary>Writes the JSON literal null as an element of a JSON array.</summary>
  1963. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  1964. </member>
  1965. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Byte},System.Decimal)">
  1966. <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>
  1967. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  1968. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1969. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1970. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1971. </member>
  1972. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Byte},System.Double)">
  1973. <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>
  1974. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  1975. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1976. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1977. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1978. </member>
  1979. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Byte},System.Int32)">
  1980. <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>
  1981. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  1982. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1983. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1984. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1985. </member>
  1986. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Byte},System.Int64)">
  1987. <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>
  1988. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  1989. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1990. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1991. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1992. </member>
  1993. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Byte},System.Single)">
  1994. <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>
  1995. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  1996. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  1997. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  1998. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  1999. </member>
  2000. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Byte},System.UInt32)">
  2001. <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>
  2002. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  2003. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2004. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2005. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2006. </member>
  2007. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Byte},System.UInt64)">
  2008. <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>
  2009. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  2010. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2011. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2012. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2013. </member>
  2014. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Char},System.Decimal)">
  2015. <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>
  2016. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2017. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2018. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2019. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2020. </member>
  2021. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Char},System.Double)">
  2022. <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>
  2023. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2024. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2025. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2026. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2027. </member>
  2028. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Char},System.Int32)">
  2029. <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>
  2030. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2031. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2032. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2033. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2034. </member>
  2035. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Char},System.Int64)">
  2036. <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>
  2037. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2038. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2039. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2040. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2041. </member>
  2042. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Char},System.Single)">
  2043. <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>
  2044. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2045. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2046. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2047. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2048. </member>
  2049. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Char},System.UInt32)">
  2050. <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>
  2051. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2052. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2053. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2054. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2055. </member>
  2056. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.ReadOnlySpan{System.Char},System.UInt64)">
  2057. <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>
  2058. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2059. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2060. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2061. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2062. </member>
  2063. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.String,System.Decimal)">
  2064. <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>
  2065. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2066. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2067. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2068. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2069. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2070. </member>
  2071. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.String,System.Double)">
  2072. <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>
  2073. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2074. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2075. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2076. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2077. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2078. </member>
  2079. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.String,System.Int32)">
  2080. <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>
  2081. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2082. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2083. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2084. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2085. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2086. </member>
  2087. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.String,System.Int64)">
  2088. <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>
  2089. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2090. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2091. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2092. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2093. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2094. </member>
  2095. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.String,System.Single)">
  2096. <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>
  2097. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2098. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2099. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2100. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2101. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2102. </member>
  2103. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.String,System.UInt32)">
  2104. <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>
  2105. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2106. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2107. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2108. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2109. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2110. </member>
  2111. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.String,System.UInt64)">
  2112. <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>
  2113. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2114. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2115. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2116. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2117. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2118. </member>
  2119. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.Text.Json.JsonEncodedText,System.Decimal)">
  2120. <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>
  2121. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2122. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2123. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  2124. </member>
  2125. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.Text.Json.JsonEncodedText,System.Double)">
  2126. <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>
  2127. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2128. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2129. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  2130. </member>
  2131. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.Text.Json.JsonEncodedText,System.Int32)">
  2132. <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>
  2133. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2134. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2135. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  2136. </member>
  2137. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.Text.Json.JsonEncodedText,System.Int64)">
  2138. <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>
  2139. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2140. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2141. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  2142. </member>
  2143. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.Text.Json.JsonEncodedText,System.Single)">
  2144. <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>
  2145. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2146. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2147. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  2148. </member>
  2149. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.Text.Json.JsonEncodedText,System.UInt32)">
  2150. <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>
  2151. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2152. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2153. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  2154. </member>
  2155. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumber(System.Text.Json.JsonEncodedText,System.UInt64)">
  2156. <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>
  2157. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2158. <param name="value">The value to be written as a JSON number as part of the name/value pair.</param>
  2159. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  2160. </member>
  2161. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumberValue(System.Decimal)">
  2162. <summary>Writes a <see cref="T:System.Decimal" /> value (as a JSON number) as an element of a JSON array.</summary>
  2163. <param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
  2164. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  2165. </member>
  2166. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumberValue(System.Double)">
  2167. <summary>Writes a <see cref="T:System.Double" /> value (as a JSON number) as an element of a JSON array.</summary>
  2168. <param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
  2169. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  2170. </member>
  2171. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumberValue(System.Int32)">
  2172. <summary>Writes an <see cref="T:System.Int32" /> value (as a JSON number) as an element of a JSON array.</summary>
  2173. <param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
  2174. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  2175. </member>
  2176. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumberValue(System.Int64)">
  2177. <summary>Writes an <see cref="T:System.Int64" /> value (as a JSON number) as an element of a JSON array.</summary>
  2178. <param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
  2179. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  2180. </member>
  2181. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumberValue(System.Single)">
  2182. <summary>Writes a <see cref="T:System.Single" /> value (as a JSON number) as an element of a JSON array.</summary>
  2183. <param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
  2184. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  2185. </member>
  2186. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumberValue(System.UInt32)">
  2187. <summary>Writes a <see cref="T:System.UInt32" /> value (as a JSON number) as an element of a JSON array.</summary>
  2188. <param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
  2189. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  2190. </member>
  2191. <member name="M:System.Text.Json.Utf8JsonWriter.WriteNumberValue(System.UInt64)">
  2192. <summary>Writes a <see cref="T:System.UInt64" /> value (as a JSON number) as an element of a JSON array.</summary>
  2193. <param name="value">The value to be written as a JSON number as an element of a JSON array.</param>
  2194. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  2195. </member>
  2196. <member name="M:System.Text.Json.Utf8JsonWriter.WritePropertyName(System.ReadOnlySpan{System.Byte})">
  2197. <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>
  2198. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  2199. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2200. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2201. </member>
  2202. <member name="M:System.Text.Json.Utf8JsonWriter.WritePropertyName(System.ReadOnlySpan{System.Char})">
  2203. <summary>Writes the property name (as a JSON string) as the first part of a name/value pair of a JSON object.</summary>
  2204. <param name="propertyName">The property name of the JSON object to be transcoded and written as UTF-8.</param>
  2205. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2206. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2207. </member>
  2208. <member name="M:System.Text.Json.Utf8JsonWriter.WritePropertyName(System.String)">
  2209. <summary>Writes the property name (as a JSON string) as the first part of a name/value pair of a JSON object.</summary>
  2210. <param name="propertyName">The property name of the JSON object to be transcoded and written as UTF-8.</param>
  2211. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2212. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2213. <exception cref="T:System.ArgumentNullException">
  2214. <paramref name="propertyName" /> is <see langword="null" />.</exception>
  2215. </member>
  2216. <member name="M:System.Text.Json.Utf8JsonWriter.WritePropertyName(System.Text.Json.JsonEncodedText)">
  2217. <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>
  2218. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2219. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2220. </member>
  2221. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStartArray">
  2222. <summary>Writes the beginning of a JSON array.</summary>
  2223. <exception cref="T:System.InvalidOperationException">The depth of the JSON exceeds the maximum depth of 1,000.
  2224. -or-
  2225. Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2226. </member>
  2227. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStartArray(System.ReadOnlySpan{System.Byte})">
  2228. <summary>Writes the beginning of a JSON array with a property name specified as a read-only span of bytes as the key.</summary>
  2229. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON array to be written.</param>
  2230. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2231. <exception cref="T:System.InvalidOperationException">The depth of the JSON exceeds the maximum depth of 1,000.
  2232. -or-
  2233. Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2234. </member>
  2235. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStartArray(System.ReadOnlySpan{System.Char})">
  2236. <summary>Writes the beginning of a JSON array with a property name specified as a read-only character span as the key.</summary>
  2237. <param name="propertyName">The UTF-16 encoded property name of the JSON array to be transcoded and written as UTF-8.</param>
  2238. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2239. <exception cref="T:System.InvalidOperationException">The depth of the JSON exceeds the maximum depth of 1,000.
  2240. -or-
  2241. Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2242. </member>
  2243. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStartArray(System.String)">
  2244. <summary>Writes the beginning of a JSON array with a property name specified as a string as the key.</summary>
  2245. <param name="propertyName">The UTF-16 encoded property name of the JSON array to be transcoded and written as UTF-8.</param>
  2246. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2247. <exception cref="T:System.InvalidOperationException">The depth of the JSON exceeds the maximum depth of 1,000.
  2248. -or-
  2249. Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2250. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2251. </member>
  2252. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStartArray(System.Text.Json.JsonEncodedText)">
  2253. <summary>Writes the beginning of a JSON array with a pre-encoded property name as the key.</summary>
  2254. <param name="propertyName">The JSON encoded property name of the JSON array to be transcoded and written as UTF-8.</param>
  2255. <exception cref="T:System.InvalidOperationException">The depth of the JSON has exceeded the maximum depth of 1,000.
  2256. -or-
  2257. Validation is enabled, and this method would result in writing invalid JSON.</exception>
  2258. </member>
  2259. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStartObject">
  2260. <summary>Writes the beginning of a JSON object.</summary>
  2261. <exception cref="T:System.InvalidOperationException">The depth of the JSON exceeds the maximum depth of 1,000.
  2262. -or-
  2263. Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  2264. </member>
  2265. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStartObject(System.ReadOnlySpan{System.Byte})">
  2266. <summary>Writes the beginning of a JSON object with a property name specified as a read-only span of bytes as the key.</summary>
  2267. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  2268. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2269. <exception cref="T:System.InvalidOperationException">The depth of the JSON exceeds the maximum depth of 1,000.
  2270. -or-
  2271. Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2272. </member>
  2273. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStartObject(System.ReadOnlySpan{System.Char})">
  2274. <summary>Writes the beginning of a JSON object with a property name specififed as a read-only character span as the key.</summary>
  2275. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2276. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2277. <exception cref="T:System.InvalidOperationException">The depth of the JSON exceeds the maximum depth of 1,000.
  2278. -or-
  2279. Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2280. </member>
  2281. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStartObject(System.String)">
  2282. <summary>Writes the beginning of a JSON object with a property name specified as a string as the key.</summary>
  2283. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2284. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2285. <exception cref="T:System.InvalidOperationException">The depth of the JSON exceeds the maximum depth of 1,000.
  2286. -or-
  2287. Validation is enabled, and this write operation would produce invalid JSON.</exception>
  2288. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2289. </member>
  2290. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStartObject(System.Text.Json.JsonEncodedText)">
  2291. <summary>Writes the beginning of a JSON object with a pre-encoded property name as the key.</summary>
  2292. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2293. <exception cref="T:System.InvalidOperationException">The depth of the JSON has exceeded the maximum depth of 1,000.
  2294. -or-
  2295. Validation is enabled, and this method would result in writing invalid JSON.</exception>
  2296. </member>
  2297. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Byte},System.DateTime)">
  2298. <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>
  2299. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  2300. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2301. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2302. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2303. </member>
  2304. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Byte},System.DateTimeOffset)">
  2305. <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>
  2306. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  2307. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2308. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2309. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2310. </member>
  2311. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Byte},System.Guid)">
  2312. <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>
  2313. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  2314. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2315. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2316. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2317. </member>
  2318. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte})">
  2319. <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>
  2320. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  2321. <param name="utf8Value">The UTF-8 encoded value to be written as a JSON string as part of the name/value pair.</param>
  2322. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  2323. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2324. </member>
  2325. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Char})">
  2326. <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>
  2327. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  2328. <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>
  2329. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  2330. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2331. </member>
  2332. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Byte},System.String)">
  2333. <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>
  2334. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  2335. <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>
  2336. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  2337. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2338. </member>
  2339. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Byte},System.Text.Json.JsonEncodedText)">
  2340. <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>
  2341. <param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
  2342. <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>
  2343. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2344. <exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
  2345. </member>
  2346. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Char},System.DateTime)">
  2347. <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>
  2348. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2349. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2350. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2351. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2352. </member>
  2353. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Char},System.DateTimeOffset)">
  2354. <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>
  2355. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2356. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2357. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2358. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2359. </member>
  2360. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Char},System.Guid)">
  2361. <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>
  2362. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2363. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2364. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2365. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2366. </member>
  2367. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Char},System.ReadOnlySpan{System.Byte})">
  2368. <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>
  2369. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2370. <param name="utf8Value">The UTF-8 encoded value to be written as a JSON string as part of the name/value pair.</param>
  2371. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  2372. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2373. </member>
  2374. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Char},System.ReadOnlySpan{System.Char})">
  2375. <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>
  2376. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2377. <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>
  2378. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  2379. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2380. </member>
  2381. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Char},System.String)">
  2382. <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>
  2383. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2384. <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>
  2385. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  2386. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2387. </member>
  2388. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.ReadOnlySpan{System.Char},System.Text.Json.JsonEncodedText)">
  2389. <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>
  2390. <param name="propertyName">The property name of the JSON object to be transcoded and written as UTF-8.</param>
  2391. <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>
  2392. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2393. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2394. </member>
  2395. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.String,System.DateTime)">
  2396. <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>
  2397. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2398. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2399. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2400. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2401. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2402. </member>
  2403. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.String,System.DateTimeOffset)">
  2404. <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>
  2405. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2406. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2407. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2408. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2409. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2410. </member>
  2411. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.String,System.Guid)">
  2412. <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>
  2413. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2414. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2415. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2416. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2417. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2418. </member>
  2419. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.String,System.ReadOnlySpan{System.Byte})">
  2420. <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>
  2421. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2422. <param name="utf8Value">The UTF-8 encoded value to be written as a JSON string as part of the name/value pair.</param>
  2423. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  2424. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2425. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2426. </member>
  2427. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.String,System.ReadOnlySpan{System.Char})">
  2428. <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>
  2429. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2430. <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>
  2431. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  2432. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2433. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2434. </member>
  2435. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.String,System.String)">
  2436. <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>
  2437. <param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2438. <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>
  2439. <exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
  2440. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2441. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2442. </member>
  2443. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.String,System.Text.Json.JsonEncodedText)">
  2444. <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>
  2445. <param name="propertyName">The property name of the JSON object to be transcoded and written as UTF-8.</param>
  2446. <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>
  2447. <exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
  2448. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2449. <exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
  2450. </member>
  2451. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.Text.Json.JsonEncodedText,System.DateTime)">
  2452. <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>
  2453. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2454. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2455. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2456. </member>
  2457. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.Text.Json.JsonEncodedText,System.DateTimeOffset)">
  2458. <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>
  2459. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2460. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2461. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2462. </member>
  2463. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.Text.Json.JsonEncodedText,System.Guid)">
  2464. <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>
  2465. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2466. <param name="value">The value to be written as a JSON string as part of the name/value pair.</param>
  2467. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2468. </member>
  2469. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.Text.Json.JsonEncodedText,System.ReadOnlySpan{System.Byte})">
  2470. <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>
  2471. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2472. <param name="utf8Value">The UTF-8 encoded value to be written as a JSON string as part of the name/value pair.</param>
  2473. <exception cref="T:System.ArgumentException">The specified value is too large.</exception>
  2474. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2475. </member>
  2476. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.Text.Json.JsonEncodedText,System.ReadOnlySpan{System.Char})">
  2477. <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>
  2478. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2479. <param name="value">The value to be written as a UTF-8 transcoded JSON string as part of the name/value pair.</param>
  2480. <exception cref="T:System.ArgumentException">The specified value is too large.</exception>
  2481. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2482. </member>
  2483. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.Text.Json.JsonEncodedText,System.String)">
  2484. <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>
  2485. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2486. <param name="value">The value to be written as a UTF-8 transcoded JSON string as part of the name/value pair.</param>
  2487. <exception cref="T:System.ArgumentException">The specified value is too large.</exception>
  2488. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2489. </member>
  2490. <member name="M:System.Text.Json.Utf8JsonWriter.WriteString(System.Text.Json.JsonEncodedText,System.Text.Json.JsonEncodedText)">
  2491. <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>
  2492. <param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
  2493. <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>
  2494. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2495. </member>
  2496. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStringValue(System.DateTime)">
  2497. <summary>Writes a <see cref="T:System.DateTime" /> value (as a JSON string) as an element of a JSON array.</summary>
  2498. <param name="value">The value to be written as a JSON string as an element of a JSON array.</param>
  2499. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  2500. </member>
  2501. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStringValue(System.DateTimeOffset)">
  2502. <summary>Writes a <see cref="T:System.DateTimeOffset" /> value (as a JSON string) as an element of a JSON array.</summary>
  2503. <param name="value">The value to be written as a JSON string as an element of a JSON array.</param>
  2504. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  2505. </member>
  2506. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStringValue(System.Guid)">
  2507. <summary>Writes a <see cref="T:System.Guid" /> value (as a JSON string) as an element of a JSON array.</summary>
  2508. <param name="value">The value to be written as a JSON string as an element of a JSON array.</param>
  2509. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
  2510. </member>
  2511. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStringValue(System.ReadOnlySpan{System.Byte})">
  2512. <summary>Writes a UTF-8 text value (as a JSON string) as an element of a JSON array.</summary>
  2513. <param name="utf8Value">The UTF-8 encoded value to be written as a JSON string element of a JSON array.</param>
  2514. <exception cref="T:System.ArgumentException">The specified value is too large.</exception>
  2515. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2516. </member>
  2517. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStringValue(System.ReadOnlySpan{System.Char})">
  2518. <summary>Writes a UTF-16 text value (as a JSON string) as an element of a JSON array.</summary>
  2519. <param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array.</param>
  2520. <exception cref="T:System.ArgumentException">The specified value is too large.</exception>
  2521. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2522. </member>
  2523. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStringValue(System.String)">
  2524. <summary>Writes a string text value (as a JSON string) as an element of a JSON array.</summary>
  2525. <param name="value">The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array.</param>
  2526. <exception cref="T:System.ArgumentException">The specified value is too large.</exception>
  2527. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2528. </member>
  2529. <member name="M:System.Text.Json.Utf8JsonWriter.WriteStringValue(System.Text.Json.JsonEncodedText)">
  2530. <summary>Writes the pre-encoded text value (as a JSON string) as an element of a JSON array.</summary>
  2531. <param name="value">The JSON encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array.</param>
  2532. <exception cref="T:System.InvalidOperationException">Validation is enabled, and the write operation would produce invalid JSON.</exception>
  2533. </member>
  2534. <member name="P:System.Text.Json.Utf8JsonWriter.BytesCommitted">
  2535. <summary>Gets the total number of bytes committed to the output by the current instance so far.</summary>
  2536. <returns>The total number of bytes committed to the output by the <see cref="T:System.Text.Json.Utf8JsonWriter" /> so far.</returns>
  2537. </member>
  2538. <member name="P:System.Text.Json.Utf8JsonWriter.BytesPending">
  2539. <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>
  2540. <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>
  2541. </member>
  2542. <member name="P:System.Text.Json.Utf8JsonWriter.CurrentDepth">
  2543. <summary>Gets the depth of the current token.</summary>
  2544. <returns>The depth of the current token.</returns>
  2545. </member>
  2546. <member name="P:System.Text.Json.Utf8JsonWriter.Options">
  2547. <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>
  2548. <returns>The custom behavior of this instance of the writer for formatting, validating, and escaping.</returns>
  2549. </member>
  2550. </members>
  2551. </doc>