diff --git a/xml/System.Text.Json/JsonDocument.xml b/xml/System.Text.Json/JsonDocument.xml index 8376cd8f7c5..4eaad6f62af 100644 --- a/xml/System.Text.Json/JsonDocument.xml +++ b/xml/System.Text.Json/JsonDocument.xml @@ -18,8 +18,14 @@ - To be added. - To be added. + Provides a mechanism for examining the structural content of a JSON value without automatically instantiating data values. + + + @@ -65,11 +71,25 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The JSON text to parse. + Options to control the reader behavior during parsing. + Parses a sequence as UTF-8-encoded text representing a single JSON byte value into a JsonDocument. + A JsonDocument representation of the JSON value. + + may be used for the entire lifetime of the JsonDocument object, and the caller must ensure that the data therein does not change during the object lifetime. + +Because the input is considered to be text, a UTF-8 Byte-Order-Mark (BOM) must not be present. + + ]]> + + + does not represent a valid single JSON value. + + + contains unsupported options. + @@ -91,11 +111,17 @@ - To be added. - To be added. - To be added. - To be added. + The JSON data to parse. + Options to control the reader behavior during parsing. + Parses a as UTF-8-encoded data representing a single JSON value into a JsonDocument. The stream is read to completion. + A JsonDocument representation of the JSON value. To be added. + + does not represent a valid single JSON value. + + + contains unsupported options. + @@ -117,11 +143,25 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The JSON text to parse. + Options to control the reader behavior during parsing. + Parses memory as UTF-8-encoded text representing a single JSON byte value into a JsonDocument. + A JsonDocument representation of the JSON value. + + value will be used for the entire lifetime of the JsonDocument object, and the caller must ensure that the data therein does not change during the object lifetime. + +Because the input is considered to be text, a UTF-8 Byte-Order-Mark (BOM) must not be present. + + ]]> + + + does not represent a valid single JSON value. + + + contains unsupported options. + @@ -143,11 +183,23 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The JSON text to parse. + Options to control the reader behavior during parsing. + Parses text representing a single JSON character value into a JsonDocument. + A JsonDocument representation of the JSON value. + + value may be used for the entire lifetime of the JsonDocument object, and the caller must ensure that the data therein does not change during the object lifetime. + + ]]> + + + does not represent a valid single JSON value. + + + contains unsupported options. + @@ -169,11 +221,17 @@ - To be added. - To be added. - To be added. - To be added. + The JSON text to parse. + Options to control the reader behavior during parsing. + Parses text representing a single JSON string value into a JsonDocument. + A JsonDocument representation of the JSON value. To be added. + + does not represent a valid single JSON value. + + + contains unsupported options. + @@ -195,12 +253,18 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The JSON data to parse. + Options to control the reader behavior during parsing. + The token to monitor for cancellation requests. + Parses a as UTF-8-encoded data representing a single JSON value into a JsonDocument. The stream is read to completion. + A task to produce a JsonDocument representation of the JSON value. To be added. + + does not represent a valid single JSON value. + + + contains unsupported options. + @@ -222,10 +286,27 @@ - To be added. - To be added. - To be added. - To be added. + The reader to read. + Parses one JSON value (including objects or arrays) from the provided reader. + A JsonDocument representing the value (and nested values) read from the reader. + + property of `reader` is or , the reader will advance by one call to to determine the start of the value. + +Upon completion of this method, `reader` is positioned at the final token in the JSON value. If an exception is thrown, the reader is reset to +the state it was in when the method was called. + +This method makes a copy of the data the reader acted on, so there is no caller requirement to maintain data integrity beyond the return of this method. + + ]]> + + + contains unsupported options. + + + A value could not be read from the reader. + @@ -244,7 +325,7 @@ System.Text.Json.JsonElement - To be added. + Gets the root element of this JSON document. To be added. To be added. @@ -269,11 +350,29 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The reader to read. + When the method returns, contains the parsed document. + Attempts to parse one JSON value (including objects or arrays) from the provided reader. + + if a value was read and parsed into a JsonDocument; if the reader ran out of data while parsing. All other situations result in an exception being thrown. + + property of `reader` is or , the reader will advance by one call to to determine the start of the value. + +Upon completion of this method, `reader` is positioned at the final token in the JSON value. If an exception is thrown or `false` +is returned, the reader is reset to the state it was in when the method was called. + +This method makes a copy of the data the reader acted on, so there is no caller requirement to maintain data integrity beyond the return of this method. + + ]]> + + + contains unsupported options. + + + A value could not be read from the reader. + diff --git a/xml/System.Text.Json/JsonElement+ArrayEnumerator.xml b/xml/System.Text.Json/JsonElement+ArrayEnumerator.xml index f015c89940a..2d89d3720ba 100644 --- a/xml/System.Text.Json/JsonElement+ArrayEnumerator.xml +++ b/xml/System.Text.Json/JsonElement+ArrayEnumerator.xml @@ -30,7 +30,7 @@ - To be added. + Represents an enumerator for the contents of a JSON array. To be added. @@ -99,8 +99,8 @@ - To be added. - To be added. + Returns an enumerator that iterates through a collection. + An enumeratore that can be used to iterate through the array. To be added. diff --git a/xml/System.Text.Json/JsonElement+ObjectEnumerator.xml b/xml/System.Text.Json/JsonElement+ObjectEnumerator.xml index d82d3ce52b3..dcfde4ad6c3 100644 --- a/xml/System.Text.Json/JsonElement+ObjectEnumerator.xml +++ b/xml/System.Text.Json/JsonElement+ObjectEnumerator.xml @@ -30,7 +30,7 @@ - To be added. + Represents an enumerator for the properties of a JSON object. To be added. @@ -99,9 +99,15 @@ - To be added. - To be added. - To be added. + Returns an enumerator that iterates the properties of an object. + An enumerator that can be used to iterate through the object. + + + diff --git a/xml/System.Text.Json/JsonElement.xml b/xml/System.Text.Json/JsonElement.xml index 75d904695c3..1654accd232 100644 --- a/xml/System.Text.Json/JsonElement.xml +++ b/xml/System.Text.Json/JsonElement.xml @@ -19,7 +19,7 @@ - To be added. + Represents a specific JSON value within a . To be added. @@ -40,9 +40,15 @@ - To be added. - To be added. - To be added. + Gets a JsonElement that can be safely stored beyond the lifetime of the original . + A JsonElement that can be safely stored beyond the lifetime of the original . + + + @@ -62,9 +68,11 @@ - To be added. - To be added. + Gets an enumerator to enumerate the values in the JSON array represented by this JsonElement. + An enumerator to enumerate the values in the JSON array represented by this JsonElement. To be added. + This value's is not . + The parent has been disposed. @@ -84,9 +92,11 @@ - To be added. - To be added. + Gets an enumerator to enumerate the properties in the JSON object represented by this JsonElement. + An enumerator to enumerate the properties in the JSON object represented by this JsonElement. To be added. + This value's is not . + The parent has been disposed. @@ -106,9 +116,11 @@ - To be added. - To be added. + Gets the number of values contained within the current array value. + The number of values contained within the current array value. To be added. + This value's is not . + The parent has been disposed. @@ -128,9 +140,17 @@ - To be added. - To be added. - To be added. + Gets the value of the element as a . + The value of the element as a . + + + + This value's is neither nor . + The parent has been disposed. @@ -150,9 +170,18 @@ - To be added. - To be added. - To be added. + Gets the value of the element as a . + The value of the element as a . + + + + This value's is not . + The value cannot be represented as a . + The parent has been disposed. @@ -172,9 +201,18 @@ - To be added. - To be added. - To be added. + Gets the value of the element as a . + The value of the element as a . + + + + This value's is not . + The value cannot be represented as a . + The parent has been disposed. @@ -194,9 +232,18 @@ - To be added. - To be added. - To be added. + Gets the current JSON number as a . + The current JSON number as a . + + + + This value's is not . + The value cannot be represented as a . + The parent has been disposed. @@ -216,9 +263,20 @@ - To be added. - To be added. - To be added. + Gets the current JSON number as a . + The current JSON number as a . + + for values larger than , and it returns for values smaller than . + + ]]> + + This value's is not . + The value cannot be represented as a . + The parent has been disposed. @@ -238,9 +296,18 @@ - To be added. - To be added. - To be added. + Gets the value of the element as a . + The value of the element as a . + + + + This value's is not . + The value cannot be represented as a . + The parent has been disposed. @@ -260,9 +327,12 @@ - To be added. - To be added. + Gets the current JSON number as an . + The current JSON number as an . To be added. + This value's is not . + The value cannot be represented as an . + The parent has been disposed. @@ -282,9 +352,18 @@ - To be added. - To be added. - To be added. + Gets the current JSON number as an . + The current JSON number as an . + + + + This value's is not . + The value cannot be represented as a . + The parent has been disposed. @@ -306,10 +385,21 @@ - To be added. - To be added. - To be added. - To be added. + The UTF-8 representation (with no Byte-Order-Mark (BOM)) of the name of the property to return. + Gets a representing the value of a required property identified by . + A representing the value of the requested property. + + + + This value's is not . + No property was found with the requested name. + The parent has been disposed. @@ -331,10 +421,21 @@ - To be added. - To be added. - To be added. - To be added. + The name of the property whose value is to be returned. + Gets a representing the value of a required property identified by . + A representing the value of the requested property. + + + + This value's is not . + No property was found with the requested name. + The parent has been disposed. @@ -356,10 +457,22 @@ - To be added. - To be added. - To be added. - To be added. + The name of the property whose value is to be returned. + Gets a representing the value of a required property identified by . + A representing the value of the requested property. + + + + This value's is not . + No property was found with the requested name. + is . + The parent has been disposed. @@ -379,9 +492,10 @@ - To be added. - To be added. + Gets a string that represents the original input data backing this value. + The original input data backing this value. To be added. + The parent has been disposed. @@ -401,9 +515,20 @@ - To be added. - To be added. - To be added. + Gets the current JSON number as a . + The current JSON number as a . + + for values larger than and for values smaller than . + + ]]> + + This value's is not . + The value cannot be represented as a . + The parent has been disposed. @@ -423,9 +548,17 @@ - To be added. - To be added. - To be added. + Gets the value of the element as a . + The value of the element as a . + + + + This value's is neither nor . + The parent has been disposed. @@ -450,9 +583,18 @@ - To be added. - To be added. - To be added. + Gets the current JSON number as a . + The current JSON number as a . + + + + This value's is not . + The value cannot be represented as a . + The parent has been disposed. @@ -477,9 +619,18 @@ - To be added. - To be added. - To be added. + Gets the current JSON number as a . + The current JSON number as a . + + + + This value's is not . + The value cannot be represented as a . + The parent has been disposed. @@ -502,9 +653,12 @@ To be added. - To be added. + Gets the value at a specified index when the current value is an . To be added. To be added. + This value's is not . + is not in the range [0, ()). + The parent has been disposed. @@ -524,9 +678,24 @@ - To be added. - To be added. - To be added. + Gets a string representation for the current value appropriate to the value type. + A string representation for the current value appropriate to the value type. + + , is returned. + +For , is returned. + +For , is returned. + +For , the value of is returned. + +For other types, the value of is returned. + + ]]> + + The parent has been disposed. @@ -548,10 +717,18 @@ - To be added. - To be added. - To be added. - To be added. + When this method returns, contains the date and time value equivalent to the current JSON string. + Attempts to represent the current JSON string as a . + if the string can be represented as a , otherwise. + + + + This value's is not . + The parent has been disposed. @@ -573,10 +750,18 @@ - To be added. - To be added. - To be added. - To be added. + When this method returns, contains the date and time equivalent to the current JSON string. + Attempts to represent the current JSON string as a . + if the string can be represented as a , otherwise. + + + + This value's is not . + The parent has been disposed. @@ -598,10 +783,18 @@ - To be added. - To be added. - To be added. - To be added. + When this method returns, contains the decimal equivalent of the current JSON number. + Attempts to represent the current JSON number as a . + if the number can be represented as a , otherwise. + + + + This value's is not . + The parent has been disposed. @@ -623,10 +816,20 @@ - To be added. - To be added. - To be added. - To be added. + When this method returns, contains a double-precision floating point value equivalent to the current JSON number. + Attempts to represent the current JSON number as a . + if the number can be represented as a , otherwise. + + or smaller than . Instead, it returns This value's is not . + The parent has been disposed. @@ -648,10 +851,18 @@ - To be added. - To be added. - To be added. - To be added. + When this method returns, contains the GUID equivalent to the current JSON string. + Attempts to represent the current JSON string as a . + if the string can be represented as a , otherwise. + + + + This value's is not . + The parent has been disposed. @@ -673,10 +884,18 @@ - To be added. - To be added. - To be added. - To be added. + When this method returns, contains the 32-biut integer value equivalent to the current JSON number. + Attempts to represent the current JSON number as an . + if the number can be represented as an , otherwise. + + + + This value's is not . + The parent has been disposed. @@ -698,10 +917,18 @@ - To be added. - To be added. - To be added. - To be added. + When this method returns, contains the 64-bit integer value equivalent to the current JSON number. + Attempts to represent the current JSON number as a . + if the number can be represented as a , otherwise. + + + + This value's is not . + The parent has been disposed. @@ -724,11 +951,21 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The UTF-8 (with no Byte-Order-Mark (BOM)) representation of the name of the property to return. + Receives the value of the located property. + Looks for a property named 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 argument. + if the property was found, otherwise. + + + + This value's is not . + The parent has been disposed. @@ -751,11 +988,21 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The name of the property to find. + When this method returns, contains the value of the specified property. + Looks for a property named 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 argument. + if the property was found, otherwise. + + + + This value's is not . + The parent has been disposed. @@ -778,11 +1025,22 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The name of the property to find. + When this method returns, contains the value of the specified property. + Looks for a property named 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 argument. + if the property was found, otherwise. + + + + This value's is not . + is . + The parent has been disposed. @@ -804,10 +1062,20 @@ - To be added. - To be added. - To be added. - To be added. + When this method returns, contains the single-precision floating point value equivalent to the current JSON number. + Attempts to represent the current JSON number as a . + if the number can be represented as a , otherwise. + + or smaller than ). Instead, it returns `false` and assigns or to the `value` argument. + + ]]> + + This value's is not . + The parent has been disposed. @@ -834,10 +1102,18 @@ - To be added. - To be added. - To be added. - To be added. + When this method returns, contains unsigned 32-bit integer value equivalent to the current JSON number. + Attempts to represent the current JSON number as a . + if the number can be represented as a , otherwise. + + + + This value's is not . + The parent has been disposed. @@ -864,10 +1140,18 @@ - To be added. - To be added. - To be added. - To be added. + When this method returns, contains unsigned 64-bit integer value equivalent to the current JSON number. + Attempts to represent the current JSON number as a . + if the number can be represented as a , otherwise. + + + + This value's is not . + The parent has been disposed. @@ -886,9 +1170,10 @@ System.Text.Json.JsonValueType - To be added. + Gets the type of the current JSON element. To be added. To be added. + The parent has been disposed. @@ -911,10 +1196,12 @@ - To be added. - To be added. - To be added. + UTF8-encoded text that represents te name for this value within the JSON object. + The writer. + Writes the element to the provided writer as an object property whose name is defined by UTF8-encoded text. To be added. + This value's is . + The parent has been disposed. @@ -937,10 +1224,12 @@ - To be added. - To be added. - To be added. + A character span that specifies the name for this value within the JSON object. + The writer. + Writes the element to the provided writer as an object property whose name is defined by the specified character span. To be added. + This value's is . + The parent has been disposed. @@ -962,9 +1251,11 @@ - To be added. - To be added. + The writer. + Writes the element to the provided writer as a value. To be added. + This value's is . + The parent has been disposed. diff --git a/xml/System.Text.Json/JsonProperty.xml b/xml/System.Text.Json/JsonProperty.xml index 0459c8e2aac..0c997dc4e07 100644 --- a/xml/System.Text.Json/JsonProperty.xml +++ b/xml/System.Text.Json/JsonProperty.xml @@ -19,7 +19,7 @@ - To be added. + Represents a single property for a JSON object. To be added. @@ -39,7 +39,7 @@ System.String - To be added. + The name of this property. To be added. To be added. @@ -61,8 +61,8 @@ - To be added. - To be added. + Provides a string representation of the property for debugging purposes. + 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. To be added. @@ -82,7 +82,7 @@ System.Text.Json.JsonElement - To be added. + The value of this property. To be added. To be added. diff --git a/xml/System.Text.Json/JsonReaderOptions.xml b/xml/System.Text.Json/JsonReaderOptions.xml index bff3364277e..23944419d97 100644 --- a/xml/System.Text.Json/JsonReaderOptions.xml +++ b/xml/System.Text.Json/JsonReaderOptions.xml @@ -34,7 +34,7 @@ System.Boolean - To be added. + 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. By default, it's set to false, and a is thrown if a trailing comma is encountered. To be added. To be added. @@ -84,7 +84,7 @@ By default, the reader throws a if i System.Int32 - To be added. + Gets or sets the maximum depth allowed when reading JSON, with the default (i.e. 0) indicating a max depth of 64. Reading past this depth will throw a . To be added. To be added. diff --git a/xml/System.Text.Json/JsonReaderState.xml b/xml/System.Text.Json/JsonReaderState.xml index 951013e4260..09b17cefa2e 100644 --- a/xml/System.Text.Json/JsonReaderState.xml +++ b/xml/System.Text.Json/JsonReaderState.xml @@ -43,9 +43,16 @@ this type can survive across async/await boundaries, and hence it's required to - To be added. - To be added. - To be added. + Defines the customized behavior of the that is different from the JSON RFC (for example how to handle comments, or the maximum depth allowed when reading). By default, the follows the JSON RFC strictly (comments within the JSON are invalid) and reads up to a maximum depth of 64. + Constructs a new instance. + + constructor with the JSON data. Unlike the , which is a ref struct, the state can survive across async/await boundaries and hence this type is required to provide support for reading in more data asynchronously before continuing with a new instance of the . + + ]]> + + The maximum depth is set to a non-positive value (< 0). diff --git a/xml/System.Text.Json/JsonValueType.xml b/xml/System.Text.Json/JsonValueType.xml index ea4a6dec396..b37f70548f0 100644 --- a/xml/System.Text.Json/JsonValueType.xml +++ b/xml/System.Text.Json/JsonValueType.xml @@ -13,7 +13,7 @@ System.Enum - To be added. + Specifies the data type of a JSON value. To be added. @@ -34,7 +34,7 @@ 2 - To be added. + Indicates that a value is a JSON array. @@ -54,7 +54,7 @@ 6 - To be added. + Indicates that a value is the JSON value false. @@ -74,7 +74,7 @@ 7 - To be added. + Indicates that a value is the JSON value null. @@ -94,7 +94,7 @@ 4 - To be added. + Indicates that a value is a JSON number. @@ -114,7 +114,7 @@ 1 - To be added. + Indicates that a value is a JSON object. @@ -134,7 +134,7 @@ 3 - To be added. + Indicates that a value is a JSON string. @@ -154,7 +154,7 @@ 5 - To be added. + Indicates that a value is the JSON value true. @@ -174,7 +174,7 @@ 0 - To be added. + Indicates that there is no value (as distinct from ). diff --git a/xml/System.Text.Json/Utf8JsonReader.xml b/xml/System.Text.Json/Utf8JsonReader.xml index 766aad661c4..b82e0941567 100644 --- a/xml/System.Text.Json/Utf8JsonReader.xml +++ b/xml/System.Text.Json/Utf8JsonReader.xml @@ -28,7 +28,9 @@ `Utf8JsonReader` processes the text sequentially with no caching and by default adheres strictly to the [JSON RFC](https://tools.ietf.org/html/rfc8259). When `Utf8JsonReader` encounters invalid JSON, it throws a with basic error information like line number and byte position on the line. + Since this type is a ref struct, it doesn't directly support async. However, it does provide support for reentrancy to read incomplete data and to continue reading once more data is presented. + To be able to set max depth while reading OR allow skipping comments, create an instance of and pass it to the reader. ]]> @@ -209,11 +211,9 @@ in more data asynchronously before continuing with a new instance of the Reads the next JSON token value from the source as a . - - if the is ; if the is . + if the is ; if the is . To be added. - - The value of the JSON token is not a boolean value (that is, or ). + The value of the JSON token isn't a boolean value (that is, or ). @@ -234,9 +234,11 @@ in more data asynchronously before continuing with a new instance of the - To be added. - To be added. + Reads the next JSON token value from the source and parses it to a . + The date and time, if the entire UTF-8 encoded token value can be successfully parsed. To be added. + The value of the JSON token isn't a . + The JSON token value is in an unsupported format. Only a subset of ISO 8601 formats are supported. @@ -256,9 +258,11 @@ in more data asynchronously before continuing with a new instance of the - To be added. - To be added. + Reads the next JSON token value from the source and parses it to a . + The date and time value, if the entire UTF-8 encoded token value can be successfully parsed. To be added. + The value of the JSON token isn't a . + The JSON token value is in an unsupported format. Only a subset of ISO 8601 formats are supported. @@ -289,10 +293,8 @@ The `GetDecimal` method throws an exception if the entire UTF-8 encoded token va ]]> - - The JSON token value isn't a . - - The JSON token value represents a number less than or greater than . + The JSON token value isn't a . + The JSON token value represents a number less than or greater than . @@ -324,10 +326,8 @@ The `GetDouble` method throws an exception if the entire UTF-8 encoded token val ]]> - - The JSON token value isn't a . - - The JSON token value represents a number less than or greater than . + The JSON token value isn't a . + The JSON token value represents a number less than or greater than . @@ -348,9 +348,11 @@ The `GetDouble` method throws an exception if the entire UTF-8 encoded token val - To be added. - To be added. + Reads the next JSON token value from the source and parses it to a . + The GUID value, if the entire UTF-8 encoded token value can be successfully parsed. To be added. + The value of the JSON token isn't a . + The JSON token value is in an unsupported format for a Guid. @@ -381,10 +383,8 @@ The `GetInt32` method throws an exception if the entire UTF-8 encoded token valu ]]> - - The JSON token value isn't a . - - The JSON token value is of the incorrect numeric format. For example, if it contains a decimal or is written in scientific notation. + The JSON token value isn't a . + The JSON token value is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation. - or- @@ -420,10 +420,8 @@ The `GetInt64` method throws an exception if the entire UTF-8 encoded token valu ]]> - - The JSON token value isn't a . - - The JSON token value is of the incorrect numeric format. For example, if it contains a decimal or is written in scientific notation. + The JSON token value isn't a . + The JSON token value is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation. - or- @@ -459,10 +457,8 @@ The `GetSingle` method throws an exception if the entire UTF-8 encoded token val ]]> - - The JSON token value isn't a . - - The JSON token value represents a number less than or greater than . + The JSON token value isn't a . + The JSON token value represents a number less than or greater than . @@ -486,8 +482,7 @@ The `GetSingle` method throws an exception if the entire UTF-8 encoded token val Reads the next JSON token value from the source, unescaped, and transcoded as a . The token value parsed to a . To be added. - - The JSON token value isn't a string (that is, not a or ). + The JSON token value isn't a string (that is, not a or ). -or- @@ -520,10 +515,8 @@ The JSON string contains invalid UTF-8 bytes or invalid UTF-16 surrogates.Reads the next JSON token value from the source and parses it to a . The UTF-8 encoded token value parsed to a . To be added. - - The JSON token value isn't a . - - The JSON token value is of the incorrect numeric format. For example, if it contains a decimal or is written in scientific notation. + The JSON token value isn't a . + The JSON token value is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation. - or- @@ -556,10 +549,8 @@ The JSON token value represents a number less than . The UTF-8 encoded token value parsed to a . To be added. - - The JSON token value isn't a . - - The JSON token value is of the incorrect numeric format. For example, if it contains a decimal or is written in scientific notation. + The JSON token value isn't a . + The JSON token value is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation. - or- @@ -638,16 +629,18 @@ For input data within a `ReadOnlySpan`, this always returns `false`. For i Read the next JSON token from the input source. - - if the token was read successfully; otherwise, . + if the token was read successfully; otherwise, . To be added. - - An invalid JSON token is encountered. + An invalid JSON token was encountered. -or- -The current depth exceeds the recursive limit set by the maximum depth. - +The current depth exceeds the recursive limit set by the maximum depth. + An invalid JSON token according to the JSON RFC is encountered. + +-or- + +The current depth exceeds the recursive limit set by the maximum depth. @@ -669,10 +662,17 @@ The current depth exceeds the recursive limit set by the maximum depth. - To be added. - To be added. - To be added. - To be added. + The UTF-8 encoded text to compare against. + Compares the UTF-8 encoded text to the unescaped JSON token value in the source and returns if they match. + if the JSON token value in the source matches the UTF-8 encoded look up text; otherwise, . + + + + The JSON token isn't a string (that is, its type is other than or ). @@ -694,10 +694,17 @@ The current depth exceeds the recursive limit set by the maximum depth. - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded text to compare against. + Compares the UTF-16 encoded text to the unescaped JSON token value in the source and returns true if they match. + if the JSON token value in the source matches the UTF-16 encoded look up text; otherwise, . + + + + The JSON text isn't a string (its type is not or ). @@ -740,10 +747,11 @@ The current depth exceeds the recursive limit set by the maximum depth. - To be added. - To be added. - To be added. + When this method returns, contains the parsed value. + Reads the next JSON token value from the source and parses it to a . + if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . To be added. + The value of the JSON token isn't a . @@ -765,10 +773,11 @@ The current depth exceeds the recursive limit set by the maximum depth. - To be added. - To be added. - To be added. + When this method returns, contains the parsed value. + Reads the next JSON token value from the source and parses it to a . + if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . To be added. + The value of the JSON token isn't a . @@ -792,11 +801,9 @@ The current depth exceeds the recursive limit set by the maximum depth. When this method returns, contains the parsed value. Reads the next JSON token value from the source and parses it to a . - - if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . + if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . To be added. - - The JSON token value isn't a . + The JSON token value isn't a . @@ -821,11 +828,9 @@ The current depth exceeds the recursive limit set by the maximum depth. When this method returns, contains the parsed value. Reads the next JSON token value from the source and parses it to a . - - if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . + if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . To be added. - - The JSON token value isn't a . + The JSON token value isn't a . @@ -848,10 +853,17 @@ The current depth exceeds the recursive limit set by the maximum depth. - To be added. - To be added. - To be added. - To be added. + When this method returns, contains the parsed value. + Reads the next JSON token value from the source and parses it to a . + if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . + + values with hyphens and without any surrounding decorations. + + ]]> + + The value of the JSON token isn't a . @@ -875,11 +887,9 @@ The current depth exceeds the recursive limit set by the maximum depth. When this method returns, contains the parsed value. Reads the next JSON token value from the source and parses it to an . - - if the entire UTF-8 encoded token value can be successfully parsed to an value; otherwise, . + if the entire UTF-8 encoded token value can be successfully parsed to an value; otherwise, . To be added. - - The JSON token value isn't a . + The JSON token value isn't a . @@ -904,11 +914,9 @@ The current depth exceeds the recursive limit set by the maximum depth. When this method returns, contains the parsed value. Reads the next JSON token value from the source and parses it to an . - - if the entire UTF-8 encoded token value can be successfully parsed to an value; otherwise, . + if the entire UTF-8 encoded token value can be successfully parsed to an value; otherwise, . To be added. - - The JSON token value isn't a . + The JSON token value isn't a . @@ -933,11 +941,9 @@ The current depth exceeds the recursive limit set by the maximum depth. When this method returns, contains the parsed value. Reads the next JSON token value from the source and parses it to a . - - if the entire UTF-8 encoded token value can be successfully parsed to an value; otherwise, . + if the entire UTF-8 encoded token value can be successfully parsed to an value; otherwise, . To be added. - - The JSON token value isn't a . + The JSON token value isn't a . @@ -967,11 +973,9 @@ The current depth exceeds the recursive limit set by the maximum depth. When this method returns, contains the parsed value. Reads the next JSON token value from the source and parses it to a . - - if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . + if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . To be added. - - The JSON token value isn't a . + The JSON token value isn't a . @@ -1001,11 +1005,9 @@ The current depth exceeds the recursive limit set by the maximum depth. When this method returns, contains the parsed value. Reads the next JSON token value from the source and parses it to a . - - if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . + if the entire UTF-8 encoded token value can be successfully parsed to a value; otherwise, . To be added. - - The JSON token value isn't a . + The JSON token value isn't a . diff --git a/xml/System.Text.Json/Utf8JsonWriter.xml b/xml/System.Text.Json/Utf8JsonWriter.xml index 5578516d590..deb29b50052 100644 --- a/xml/System.Text.Json/Utf8JsonWriter.xml +++ b/xml/System.Text.Json/Utf8JsonWriter.xml @@ -54,10 +54,11 @@ To be able to format the output with indentation and white space OR to skip vali - To be added. - To be added. - To be added. + The destination for writing JSON text. + Defines the customized behavior of the By default, it writes minimized JSON (with no extra whitespace) and validates that the JSON being written is structurally valid according to the JSON RFC. + Constructs a new instance with a specified . To be added. + is . @@ -76,10 +77,11 @@ To be able to format the output with indentation and white space OR to skip vali - To be added. - To be added. - To be added. + The destination for writing JSON text. + Defines the customized behavior of the By default, it writes minimized JSON (with no extra whitespace) and validates that the JSON being written is structurally valid according to the JSON RFC. + Constructs a new instance with a specified . To be added. + is . @@ -98,10 +100,17 @@ To be able to format the output with indentation and white space OR to skip vali System.Int64 - Gets the total number of bytes committed to the output by the so far for the current instance of the . - This indicates how much the has advanced. + Gets the total number of bytes committed to the output by the current instance so far. The total number of bytes committed to the output by the so far. - To be added. + + , this property indicates how much the IBufferWriter has advanced. + +In the case of a , this property indicates how much data has been written to the stream. + + ]]> + @@ -120,7 +129,7 @@ To be able to format the output with indentation and white space OR to skip vali System.Int32 - To be added. + Gets the number of bytes written by the so far that have not yet been flushed to the output and committed. To be added. To be added. @@ -174,8 +183,16 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. + Commits any leftover JSON text that has not yet been flushed and releases all resources used by the current instance. + + based on what has been written so far. + +In the case of Stream, this writes the data to the stream and flushes it. + + ]]> + @@ -198,9 +215,17 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. + Asynchronously commits any leftover JSON text that has not yet been flushed and releases all resources used by the current instance. To be added. - To be added. + + based on what has been written so far. + +In the case of Stream, this writes the data to the stream and flushes it. + + ]]> + @@ -220,8 +245,17 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. + Commits the JSON text written so far, which makes it visible to the output destination. + + based on what has been written so far. + +In the case of , this writes the data to the stream and flushes it. + + ]]> + + This instance has been disposed. @@ -242,9 +276,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a To be added. - To be added. + Asynchronously commits the JSON text written so far, which makes it visible to the output destination. To be added. - To be added. + + based on what has been written so far. + +In the case of , this writes the data to the stream and flushes it asynchronously, while monitoring cancellation requests. + + ]]> + + This instance has been disposed. @@ -263,7 +306,7 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a System.Text.Json.JsonWriterOptions - To be added. + Gets the custom behavior when writing JSON using this instance, which indicates whether to format the output while writing and whether to skip structural JSON validation. To be added. To be added. @@ -285,8 +328,15 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. + Resets the internal state of this instance so that it can be reused. + + will continue to use the original writer options and the original output (either or ) as the destination. + + ]]> + + This instance has been disposed. @@ -308,9 +358,17 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. + The destination for writing JSON text. + Resets the internal state of this instance so that it can be reused with a new instance of . + + will continue to use the original writer options but now writes to `bufferWriter` as the new destination. + + ]]> + + is . + This instance has been disposed. @@ -332,9 +390,17 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. + The destination for writing JSON text. + Resets the internal state of this instance so that it can be reused with a new instance of . + + will continue to use the original writer options but now write to `utf8Json` as the new destination. + + ]]> + + is . + This instance has been disposed. @@ -357,10 +423,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON literal "true" or "false" as part of the name/value pair. + Writes a property name specified as a read-only span of bytes and a value (as a JSON literal "true" or "false") as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the operation would result in writing invalid JSON. @@ -383,10 +457,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON literal "true" or "false" as part of the name/value pair. + Writes a property name specified as a read-only character span and a value (as a JSON literal "true" or "false") as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the operation would result in writing invalid JSON. @@ -409,10 +491,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON literal "true" or "false" as part of the name/value pair. + Writes a property name specified as a string and a value (as a JSON literal "true" or "false") as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the operation would result in writing invalid JSON. @@ -435,10 +525,9 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a The value to be written as a JSON literal "true" or "false" as an element of a JSON array. - Writes the value (as a JSON literal "true" or "false") as an element of a JSON array. + Writes a value (as a JSON literal "true" or "false") as an element of a JSON array. To be added. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Validation is enabled, and the operation would result in writing invalid JSON. @@ -460,9 +549,20 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. + The UTF-8 encoded value to be written as a JSON comment within /*..*/. + Writes a UTF-8 text value as a JSON comment. + + + + The specified value is too large. + +-or- + + contains a comment delimiter (i.e. */). @@ -484,9 +584,20 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within /*..*/. + Writes a UTF-16 text value as a JSON comment. + + + + The specified value is too large OR. + +-or- + + contains a comment delimiter (i.e. */). @@ -508,9 +619,20 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within /*..*/. + Writes a string text value as a JSON comment. + + + + The specified value is too large. + +-or- + + contains a comment delimiter (i.e. */). @@ -532,8 +654,7 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a Writes the end of a JSON array. To be added. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Validation is enabled, and the operation would result in writing invalid JSON. @@ -555,8 +676,7 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a Writes the end of a JSON object. To be added. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Validation is enabled, and the operation would result in writing invalid JSON. @@ -578,9 +698,17 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. + The UTF-8 encoded property name of the JSON object to be written. + 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. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -602,9 +730,17 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + 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. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -626,9 +762,17 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + Writes a property name specified as a string and the JSON literal "null" as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -650,8 +794,7 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a Writes the JSON literal "null" as an element of a JSON array. To be added. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Validation is enabled, and the operation would result in writing invalid JSON. @@ -674,10 +817,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON number as part of the name/value pair. + Writes a property name specified as a read-only span of bytes and a value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -700,10 +851,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON number as part of the name/value pair. + Writes a property name specified as a read-only span of bytes and a value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -726,10 +885,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON number as part of the name/value pair. + Writes a property name specified as a read-only span of bytes and an value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -752,10 +919,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON number as part of the name/value pair. + Writes a property name specified as a read-only span of bytes and an value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -778,10 +953,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON number as part of the name/value pair. + Writes a property name specified as a read-only span of bytes and a value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -809,10 +992,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON number as part of the name/value pair. + Writes a property name specified as a read-only span of bytes and a value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -840,10 +1031,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON number as part of the name/value pair. + Writes a property name specified as a read-only span of bytes and a value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -866,10 +1065,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Writes a property name specified as a read-only character span and a value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -892,10 +1099,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Writes a property name specified as a read-only character span and a value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -918,10 +1133,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Writes a property name specified as a read-only character span and an value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -944,10 +1167,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Writes a property name specified as a read-only character span and an value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -970,10 +1201,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Writes a property name specified as a read-only character span and a value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1001,10 +1240,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Writes a property name specified as a read-only character span and a value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1032,10 +1279,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Writes a property name specified as a read-only character span and a value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1058,10 +1313,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Writes a property name specified as a string and a value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1084,10 +1347,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Writes a property name specified as a string and a value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1110,10 +1381,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Writes a property name specified as a string and an value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1136,10 +1415,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Writes a property name specified as a string and an value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1162,10 +1449,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Writes a property name specified as a string and a value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1193,10 +1488,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Writes a property name specified as a string and a value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1224,10 +1527,18 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON number as part of the name/value pair. + Writes a property name specified as a string and a value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1250,12 +1561,11 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a The value to be written as a JSON number as an element of a JSON array. - Writes the value (as a JSON number) as an element of a JSON array. + Writes a value (as a JSON number) as an element of a JSON array. - Writes the using the default (that is, 'G'). + This method writes the value using the default (that is, 'G'). - - The JSON data to be written would be invalid JSON (while validation is enabled). + Validation is enabled, and the operation would result in writing invalid JSON. @@ -1278,12 +1588,11 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a The value to be written as a JSON number as an element of a JSON array. - Writes the value (as a JSON number) as an element of a JSON array. + Writes a value (as a JSON number) as an element of a JSON array. - Writes the using the default (that is, 'G'). + This method writes the value using the default (that is, 'G'). - - The JSON data to be written would be invalid JSON (while validation is enabled). + Validation is enabled, and the operation would result in writing invalid JSON. @@ -1306,12 +1615,11 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a The value to be written as a JSON number as an element of a JSON array. - Writes the value (as a JSON number) as an element of a JSON array. + Writes an value (as a JSON number) as an element of a JSON array. - Writes the using the default (that is, 'G'). For example, 32767. + This method writes the value using the default (that is, 'G'). For example, 32767. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Validation is enabled, and the operation would result in writing invalid JSON. @@ -1334,12 +1642,11 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a The value to be written as a JSON number as an element of a JSON array. - Writes the value (as a JSON number) as an element of a JSON array. + Writes an value (as a JSON number) as an element of a JSON array. - Writes the using the default (that is, 'G'). For example, 32767. + This method writes the value using the default (that is, 'G'). For example, 32767. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Validation is enabled, and the operation would result in writing invalid JSON. @@ -1362,12 +1669,11 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a The value to be written as a JSON number as an element of a JSON array. - Writes the value (as a JSON number) as an element of a JSON array. + Writes a value (as a JSON number) as an element of a JSON array. - Writes the using the default (that is, 'G'). + This method writes the value using the default (that is, 'G'). - - The JSON data to be written would be invalid JSON (while validation is enabled). + Validation is enabled, and the operation would result in writing invalid JSON. @@ -1395,12 +1701,11 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a The value to be written as a JSON number as an element of a JSON array. - Writes the value (as a JSON number) as an element of a JSON array. + Writes a value (as a JSON number) as an element of a JSON array. - Writes the using the default (that is, 'G'). For example, 32767. + This method writes the value using the default (that is, 'G'). For example, 32767. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Validation is enabled, and the operation would result in writing invalid JSON. @@ -1428,12 +1733,11 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a The value to be written as a JSON number as an element of a JSON array. - Writes the value (as a JSON number) as an element of a JSON array. + Writes a value (as a JSON number) as an element of a JSON array. - Writes the using the default (that is, 'G'). For example, 32767. + This method writes the value using the default (that is, 'G'). For example, 32767. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Validation is enabled, and the operation would result in writing invalid JSON. @@ -1455,13 +1759,11 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a Writes the beginning of a JSON array. To be added. - - The depth of the JSON has exceeded the maximum depth of 1000. + The depth of the JSON exceeds the maximum depth of 1000. -or- -if this would result in an invalid JSON to be written (while validation is enabled). - +Validation is enabled, and this write operation would produce invalid JSON. @@ -1483,9 +1785,21 @@ if this would result in an invalid JSON to be written (while validation is enabl - To be added. - To be added. - To be added. + The UTF-8 encoded property name of the JSON array to be written. + Writes the beginning of a JSON array with a property name specified as a read-only span of bytes as the key. + + + + The specified property name is too large. + The depth of the JSON exceeds the maximum depth of 1000. + +-or- + +Validation is enabled, and this write operation would produce invalid JSON. @@ -1507,9 +1821,21 @@ if this would result in an invalid JSON to be written (while validation is enabl - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON array to be transcoded and written as UTF-8. + Writes the beginning of a JSON array with a property name specified as a read-only character span as the key. + + + + The specified property name is too large. + The depth of the JSON exceeds the maximum depth of 1000. + +-or- + +Validation is enabled, and this write operation would produce invalid JSON. @@ -1531,9 +1857,21 @@ if this would result in an invalid JSON to be written (while validation is enabl - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON array to be transcoded and written as UTF-8. + Writes the beginning of a JSON array with a property name specified as a string as the key. + + + + The specified property name is too large. + The depth of the JSON exceeds the maximum depth of 1000. + +-or- + +Validation is enabled, and this write operation would produce invalid JSON. @@ -1555,13 +1893,11 @@ if this would result in an invalid JSON to be written (while validation is enabl Writes the beginning of a JSON object. To be added. - - The depth of the JSON has exceeded the maximum depth of 1000. + The depth of the JSON exceeds the maximum depth of 1000. -or- -The JSON data to be written would be invalid JSON (while validation is enabled). - +Validation is enabled, and the operation would result in writing invalid JSON. @@ -1583,9 +1919,21 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. + The UTF-8 encoded property name of the JSON object to be written. + Writes the beginning of a JSON object with a property name specified as a read-only span of bytes as the key. + + + + The specified property name is too large. + The depth of the JSON exceeds the maximum depth of 1000. + +-or- + +Validation is enabled, and this write operation would produce invalid JSON. @@ -1607,9 +1955,21 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + Writes the beginning of a JSON object with a property name specififed as a read-only character span as the key. + + + + The specified property name is too large. + The depth of the JSON exceeds the maximum depth of 1000. + +-or- + +Validation is enabled, and this write operation would produce invalid JSON. @@ -1631,9 +1991,21 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + Writes the beginning of a JSON object with a property name specified as a string as the key. + + + + The specified property name is too large. + The depth of the JSON exceeds the maximum depth of 1000. + +-or- + +Validation is enabled, and this write operation would produce invalid JSON. @@ -1656,10 +2028,18 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. - To be added. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON string as part of the name/value pair. + Writes a UTF-8 property name and a value (as a JSON string) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1682,10 +2062,18 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. - To be added. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON string as part of the name/value pair. + Writes a UTF-8 property name and a value (as a JSON string) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1708,10 +2096,18 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. - To be added. + The UTF-8 encoded property name of the JSON object to be written. + The value to be written as a JSON string as part of the name/value pair. + Writes a UTF-8 property name and a value (as a JSON string) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1734,10 +2130,18 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. - To be added. + The UTF-8 encoded property name of the JSON object to be written. + The UTF-8 encoded value to be written as a JSON string as part of the name/value pair. + 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. + + + + The specified property name or value is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1760,10 +2164,18 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. - To be added. + The UTF-8 encoded property name of the JSON object to be written. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + 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. + + + + The specified property name or value is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1786,10 +2198,18 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. - To be added. + The UTF-8 encoded property name of the JSON object to be written. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + 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. + + + + The specified property name or value is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1812,10 +2232,18 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON string as part of the name/value pair. + Writes a property name specified as a read-only character span and a value (as a JSON string) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1838,10 +2266,18 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON string as part of the name/value pair. + Writes a property name specified as a read-only character span and a value (as a JSON string) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1864,10 +2300,18 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON string as part of the name/value pair. + Writes a property name specified as a read-only character span and a value (as a JSON string) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1890,10 +2334,18 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The UTF-8 encoded value to be written as a JSON string as part of the name/value pair. + 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. + + + + The specified property name or value is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1916,10 +2368,18 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + 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. + + + + The specified property name or value is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1942,10 +2402,18 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + 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. + + + + The specified property name or value is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1968,10 +2436,18 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON string as part of the name/value pair. + Writes a property name specified as a string and a value (as a JSON string) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -1994,10 +2470,18 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON string as part of the name/value pair. + Writes a property name specified as a string and a value (as a JSON string) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -2020,10 +2504,18 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The value to be written as a JSON string as part of the name/value pair. + Writes a property name specified as a string and a value (as a JSON string) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -2046,10 +2538,18 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The UTF-8 encoded value to be written as a JSON string as part of the name/value pair. + 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. + + + + The specified property name or value is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -2072,10 +2572,18 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + 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. + + + + The specified property name or value is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -2098,10 +2606,18 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. - To be added. + The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string as part of the name/value pair. + 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. + + + + The specified property name or value is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -2124,12 +2640,11 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value to be written as a JSON string as an element of a JSON array. - Writes the value (as a JSON string) as an element of a JSON array. + Writes a value (as a JSON string) as an element of a JSON array. - Writes the using the round-trippable ('O') . For example, 2017-06-12T05:30:45.7680000. + This method writes the using the round-trippable ('O') . For example, 2017-06-12T05:30:45.7680000. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Validation is enabled, and the operation would result in writing invalid JSON. @@ -2152,12 +2667,11 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value to be written as a JSON string as an element of a JSON array. - Writes the value (as a JSON string) as an element of a JSON array. + Writes a value (as a JSON string) as an element of a JSON array. - Writes the using the round-trippable ('O') . For example, 2017-06-12T05:30:45.7680000-07:00. + This method writes the using the round-trippable ('O') . For example, 2017-06-12T05:30:45.7680000-07:00. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Validation is enabled, and the operation would result in writing invalid JSON. @@ -2180,12 +2694,11 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The value to be written as a JSON string as an element of a JSON array. - Writes the value (as a JSON string) as an element of a JSON array. + Writes a value (as a JSON string) as an element of a JSON array. - Writes the using the default (that is, 'D'), as the form: nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn. + This method writes the value using the default (that is, 'D'), as the form: nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn. - - The JSON data to be written would be invalid JSON (while validation is enabled). + Validation is enabled, and the operation would result in writing invalid JSON. @@ -2207,9 +2720,17 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. + The UTF-8 encoded value to be written as a JSON string element of a JSON array. + Writes a UTF-8 text value (as a JSON string) as an element of a JSON array. + + + + The specified value is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -2231,9 +2752,17 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array. + Writes a UTF-16 text value (as a JSON string) as an element of a JSON array. + + + + The specified value is too large. + Validation is enabled, and the write operation would produce invalid JSON. @@ -2255,9 +2784,17 @@ The JSON data to be written would be invalid JSON (while validation is enabled). - To be added. - To be added. - To be added. + The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array. + Writes a string text value (as a JSON string) as an element of a JSON array. + + + + The specified value is too large. + Validation is enabled, and the write operation would produce invalid JSON.