From 90f9185f1c740483c73d102d6de5379bb51cca58 Mon Sep 17 00:00:00 2001 From: carlossanlop Date: Mon, 20 May 2019 10:16:28 -0700 Subject: [PATCH 1/3] Port System.Text.Json source code comments to Docs - second attempt with most up-to-date APIs. --- xml/System.Text.Json/JsonDocument.xml | 181 ++- .../JsonElement+ArrayEnumerator.xml | 6 +- .../JsonElement+ObjectEnumerator.xml | 14 +- xml/System.Text.Json/JsonElement.xml | 545 +++++++-- xml/System.Text.Json/JsonProperty.xml | 10 +- xml/System.Text.Json/JsonReaderOptions.xml | 4 +- xml/System.Text.Json/JsonReaderState.xml | 13 +- xml/System.Text.Json/JsonValueType.xml | 18 +- xml/System.Text.Json/Utf8JsonReader.xml | 154 ++- xml/System.Text.Json/Utf8JsonWriter.xml | 1074 ++++++++++++----- 10 files changed, 1470 insertions(+), 549 deletions(-) diff --git a/xml/System.Text.Json/JsonDocument.xml b/xml/System.Text.Json/JsonDocument.xml index 8376cd8f7c5..b82819fa5fa 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. + JSON text to parse. + Options to control the reader behavior during parsing. + Parse a sequence as UTF-8-encoded text representing a single JSON 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. + JSON data to parse. + Options to control the reader behavior during parsing. + Parse a as UTF-8-encoded data representing a single JSON value into a JsonDocument. The Stream will be 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. + JSON text to parse. + Options to control the reader behavior during parsing. + Parse memory as UTF-8-encoded text representing a single JSON 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. + JSON text to parse. + Options to control the reader behavior during parsing. + Parse text representing a single JSON 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. + JSON text to parse. + Options to control the reader behavior during parsing. + Parse text representing a single JSON 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. + JSON data to parse. + Options to control the reader behavior during parsing. + The token to monitor for cancellation requests. + Parse a as UTF-8-encoded data representing a single JSON value into a JsonDocument. The Stream will be 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,28 @@ - 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 be advanced by one call to to determine +the start of the value. + +Upon completion of this method `reader` will be 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. + + ]]> + + + is using unsupported options. + + + A value could not be read from the reader. + @@ -244,7 +326,7 @@ System.Text.Json.JsonElement - To be added. + The representing the value of the document. To be added. To be added. @@ -269,11 +351,30 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The reader to read. + Receives 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 be advanced by one call to to determine +the start of the value. + +Upon completion of this method `reader` will be 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. + + ]]> + + + is using 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..834c6f1c602 100644 --- a/xml/System.Text.Json/JsonElement+ArrayEnumerator.xml +++ b/xml/System.Text.Json/JsonElement+ArrayEnumerator.xml @@ -30,7 +30,7 @@ - To be added. + An enumerable and 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 value 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..f99d03fe254 100644 --- a/xml/System.Text.Json/JsonElement+ObjectEnumerator.xml +++ b/xml/System.Text.Json/JsonElement+ObjectEnumerator.xml @@ -30,7 +30,7 @@ - To be added. + An enumerable and 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 value 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..0d41eddf137 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. + Get a JsonElement which can be safely stored beyond the lifetime of the original . + A JsonElement which can be safely stored beyond the lifetime of the original . + + + @@ -62,9 +68,11 @@ - To be added. - To be added. + Get 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. + Get 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. + Get 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 or . + 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 . + + (or ) for values larger than (or 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 a . + The current JSON number as a . + + + + 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 (with no Byte-Order-Mark (BOM)) representation 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. + Name of the property whose value 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. @@ -356,10 +457,22 @@ - To be added. - To be added. - To be added. - To be added. + Name of the property whose value 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. + is . + The parent has been disposed. @@ -379,9 +492,10 @@ - To be added. - To be added. + Gets the original input data backing this value, returning it as a . + The original input data backing this value, returning it as a . 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 . + + (or ) for values larger than (or 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. + Get the value at a specified index when the current value is a . 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. + Receives the value. + 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. + Receives the value. + 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. + Receives the value. + 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. + Receives the value. + Attempts to represent the current JSON number as a . + if the number can be represented as a , otherwise. + + for values larger than (or smaller than ), instead 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. + Receives the value. + 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. + Receives the value. + 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. + Receives the value. + 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 whether or not such a property existed. When the property exists is assigned to the value of that property. + 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. + Name of the property to find. + Receives the value of the located property. + Looks for a property named in the current object, returning whether or not such a property existed. When the property exists is assigned to the value of that property. + 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. + Name of the property to find. + Receives the value of the located property. + Looks for a property named in the current object, returning whether or not such a property existed. When the property exists is assigned to the value of that property. + 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. + Receives the value. + Attempts to represent the current JSON number as a . + if the number can be represented as a , otherwise. + + (or smaller than ), instead `false` is returned and (or ) is emitted. + + ]]> + + 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. + Receives the value. + 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. + Receives the value. + 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. + The that the value is. To be added. To be added. + The parent has been disposed. @@ -911,10 +1196,12 @@ - To be added. - To be added. - To be added. + The name for this value within the JSON object, as UTF-8 text. + The writer. + Write the element into the provided writer as a named object property. 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. + The name for this value within the JSON object. + The writer. + Write the element into the provided writer as a named object property. To be added. + This value's is . + The parent has been disposed. @@ -962,9 +1251,11 @@ - To be added. - To be added. + The writer. + Write the element into 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..5a90597d3d0 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 representation of the property for debugging purposes. + A string containing the un-interpreted 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..a4d2fc7c3b4 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 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..5d20f93ff5d 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 maximum depth allowed when reading). By default, the follows the JSON RFC strictly (i.e. comments within the JSON are invalid) and reads up to a maximum depth of 64. + Constructs a new instance. + + ctor 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 . + + ]]> + + Thrown when the max 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..8e188558d6a 100644 --- a/xml/System.Text.Json/Utf8JsonReader.xml +++ b/xml/System.Text.Json/Utf8JsonReader.xml @@ -209,11 +209,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 is not a boolean value (that is, or ). @@ -234,9 +232,11 @@ in more data asynchronously before continuing with a new instance of the - To be added. + Reads the next JSON token value from the source and parses it to a . Returns the value if the entire UTF-8 encoded token value can be successfully parsed to a value. Throws exceptions otherwise. To be added. To be added. + Thrown if trying to get the value of a JSON token that is not a . + Thrown if the JSON token value is of an unsupported format. Only a subset of ISO 8601 formats are supported. @@ -256,9 +256,11 @@ in more data asynchronously before continuing with a new instance of the - To be added. + Reads the next JSON token value from the source and parses it to a . Returns the value if the entire UTF-8 encoded token value can be successfully parsed to a value. Throws exceptions otherwise. To be added. To be added. + Thrown if trying to get the value of a JSON token that is not a . + Thrown if the JSON token value is of an unsupported format. Only a subset of ISO 8601 formats are supported. @@ -289,10 +291,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 +324,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 +346,11 @@ The `GetDouble` method throws an exception if the entire UTF-8 encoded token val - To be added. + Reads the next JSON token value from the source and parses it to a . Returns the value if the entire UTF-8 encoded token value can be successfully parsed to a value. Throws exceptions otherwise. To be added. To be added. + Thrown if trying to get the value of a JSON token that is not a . + Thrown if the JSON token value is of an unsupported format for a Guid. @@ -381,10 +381,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, if it contains a decimal or is written in scientific notation. - or- @@ -420,10 +418,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, if it contains a decimal or is written in scientific notation. - or- @@ -459,10 +455,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 +480,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 +513,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, if it contains a decimal or is written in scientific notation. - or- @@ -556,10 +547,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, if it contains a decimal or is written in scientific notation. - or- @@ -638,16 +627,14 @@ 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 is 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. + Thrown when an invalid JSON token is encountered according to the JSON RFC or if the current depth exceeds the recursive limit set by the max depth. @@ -669,10 +656,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 true if they match. + True if the JSON token value in the source matches the UTF-8 encoded look up text. + + + + Thrown if trying to find a text match on a JSON token that is not a string (i.e. other than or ). @@ -694,10 +688,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. + True if the JSON token value in the source matches the UTF-16 encoded look up text. + + + + Thrown if trying to find a text match on a JSON token that is not a string (i.e. other than or ). @@ -741,9 +742,10 @@ The current depth exceeds the recursive limit set by the maximum depth. To be added. - To be added. + Reads the next JSON token value from the source and parses it to a . Returns if the entire UTF-8 encoded token value can be successfully parsed to a value. Returns otherwise. To be added. To be added. + Thrown if trying to get the value of a JSON token that is not a . @@ -766,9 +768,10 @@ The current depth exceeds the recursive limit set by the maximum depth. To be added. - To be added. + Reads the next JSON token value from the source and parses it to a . Returns if the entire UTF-8 encoded token value can be successfully parsed to a value. Returns otherwise." To be added. To be added. + Thrown if trying to get the value of a JSON token that is not a . @@ -792,11 +795,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 +822,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 . @@ -849,9 +848,10 @@ The current depth exceeds the recursive limit set by the maximum depth. To be added. - To be added. + Reads the next JSON token value from the source and parses it to a . Returns if the entire UTF-8 encoded token value can be successfully parsed to a value. Only supports values with hyphens and without any surrounding decorations. Returns otherwise. To be added. To be added. + Thrown if trying to get the value of a JSON token that is not a . @@ -875,11 +875,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 +902,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 +929,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 +961,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 +993,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..d0708d713e4 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. + An instance of used as a destination for writing JSON text into. + Defines the customized behavior of the By default, the writes JSON minimized (i.e. with no extra whitespace) and validates that the JSON being written is structurally valid according to JSON RFC. + Constructs a new instance with a specified . To be added. + The instance of that is passed in 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. + An instance of used as a destination for writing JSON text into. + Defines the customized behavior of the By default, the writes JSON minimized (i.e. with no extra whitespace) and validates that the JSON being written is structurally valid according to JSON RFC. + Constructs a new instance with a specified . To be added. + The instance of that is passed in is . @@ -101,7 +103,15 @@ To be able to format the output with indentation and white space OR to skip vali 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. The total number of bytes committed to the output by the so far. - To be added. + + + @@ -120,7 +130,7 @@ To be able to format the output with indentation and white space OR to skip vali System.Int32 - To be added. + Returns the amount 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 +184,16 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. + Commits any left over 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 +216,17 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. + Asynchronously commits any left over 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 +246,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 Stream, this writes the data to the stream and flushes it. + + ]]> + + The instance of has been disposed. @@ -242,9 +277,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 Stream, this writes the data to the stream and flushes it asynchronously, while monitoring cancellation requests. + + ]]> + + The instance of has been disposed. @@ -263,7 +307,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 the which indicates whether to format the output while writing and whether to skip structural JSON validation or not. To be added. To be added. @@ -285,8 +329,15 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. + Resets the internal state so that it can be re-used. + + will continue to use the original writer options and the original output as the destination (either or ). + + ]]> + + The instance of has been disposed. @@ -308,9 +359,17 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. + An instance of used as a destination for writing JSON text into. + Resets the internal state so that it can be re-used with the new instance of . + + will continue to use the original writer options but now write to the passed in as the new destination. + + ]]> + + The instance of that is passed in is . + The instance of has been disposed. @@ -332,9 +391,17 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - To be added. - To be added. - To be added. + An instance of used as a destination for writing JSON text into. + Resets the internal state so that it can be re-used with the new instance of . + + will continue to use the original writer options but now write to the passed in as the new destination. + + ]]> + + The instance of that is passed in is . + The instance of has been disposed. @@ -357,10 +424,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 the property name and 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. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -383,10 +458,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 the property name and 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. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -409,10 +492,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 the property name and 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. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -437,8 +528,7 @@ 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. To be added. - - The JSON data to be written would be invalid JSON (while validation is enabled). + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -460,9 +550,16 @@ 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 the UTF-8 text value (as a JSON comment). + + + + The specified value is too large OR if the given UTF-8 text value contains a comment delimiter (i.e. */). @@ -484,9 +581,16 @@ 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 the UTF-16 text value (as a JSON comment). + + + + The specified value is too large OR if the given UTF-16 text value contains a comment delimiter (i.e. */). @@ -508,9 +612,16 @@ 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 the string text value (as a JSON comment). + + + + The specified value is too large OR if the given string text value contains a comment delimiter (i.e. */). @@ -532,8 +643,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). + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -555,8 +665,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). + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -578,9 +687,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 the property name and the JSON literal "null" as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -602,9 +719,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 the property name and the JSON literal "null" as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -626,9 +751,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 the property name and the JSON literal "null" as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -650,8 +783,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). + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -674,10 +806,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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -700,10 +840,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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -726,10 +874,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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -752,10 +908,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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -778,10 +942,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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -809,10 +981,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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -840,10 +1020,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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -866,10 +1054,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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -892,10 +1088,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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -918,10 +1122,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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -944,10 +1156,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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -970,10 +1190,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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1001,10 +1229,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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1032,10 +1268,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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1058,10 +1302,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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1084,10 +1336,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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1110,10 +1370,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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1136,10 +1404,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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1162,10 +1438,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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1193,10 +1477,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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1224,10 +1516,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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1254,8 +1554,7 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a Writes the using the default (that is, 'G'). - - The JSON data to be written would be invalid JSON (while validation is enabled). + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1282,8 +1581,7 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a Writes the using the default (that is, 'G'). - - The JSON data to be written would be invalid JSON (while validation is enabled). + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1310,8 +1608,7 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a Writes the using the default (that is, 'G'). For example, 32767. - - The JSON data to be written would be invalid JSON (while validation is enabled). + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1338,8 +1635,7 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a Writes the using the default (that is, 'G'). For example, 32767. - - The JSON data to be written would be invalid JSON (while validation is enabled). + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1366,8 +1662,7 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a Writes the using the default (that is, 'G'). - - The JSON data to be written would be invalid JSON (while validation is enabled). + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1399,8 +1694,7 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a Writes the using the default (that is, 'G'). For example, 32767. - - The JSON data to be written would be invalid JSON (while validation is enabled). + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1432,8 +1726,7 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a Writes the using the default (that is, 'G'). For example, 32767. - - The JSON data to be written would be invalid JSON (while validation is enabled). + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1455,13 +1748,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 has exceeded the maximum depth of 1000. -or- -if this would result in an invalid JSON to be written (while validation is enabled). - +if this would result in an invalid JSON to be written (while validation is enabled). @@ -1483,9 +1774,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 as the key. + + + + The specified property name is too large. + The depth of the JSON has exceeded the maximum depth of 1000 + +-or- + +if this would result in an invalid JSON to be written (while validation is enabled). @@ -1507,9 +1810,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 as the key. + + + + The specified property name is too large. + The depth of the JSON has exceeded the maximum depth of 1000 + +-or- + +if this would result in an invalid JSON to be written (while validation is enabled). @@ -1531,9 +1846,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 as the key. + + + + The specified property name is too large. + The depth of the JSON has exceeded the maximum depth of 1000 + +-or- + +if this would result in an invalid JSON to be written (while validation is enabled). @@ -1555,13 +1882,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 has exceeded the maximum depth of 1000. -or- -The JSON data to be written would be invalid JSON (while validation is enabled). - +The JSON data to be written would be invalid JSON (while validation is enabled). @@ -1583,9 +1908,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 as the key. + + + + The specified property name is too large. + The depth of the JSON has exceeded the maximum depth of 1000 + +-or- + +if this would result in an invalid JSON to be written (while validation is enabled). @@ -1607,9 +1944,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 as the key. + + + + The specified property name is too large. + The depth of the JSON has exceeded the maximum depth of 1000 + +-or- + +if this would result in an invalid JSON to be written (while validation is enabled). @@ -1631,9 +1980,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 as the key. + + + + The specified property name is too large. + The depth of the JSON has exceeded the maximum depth of 1000 + +-or- + +if this would result in an invalid JSON to be written (while validation is enabled). @@ -1656,10 +2017,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 the property name and value (as a JSON string) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1682,10 +2051,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 the property name and value (as a JSON string) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1708,10 +2085,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 the property name and value (as a JSON string) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1734,10 +2119,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 the 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. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1760,10 +2153,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 the 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. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1786,10 +2187,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 the 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. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1812,10 +2221,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 the property name and value (as a JSON string) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1838,10 +2255,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 the property name and value (as a JSON string) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1864,10 +2289,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 the property name and value (as a JSON string) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1890,10 +2323,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 the 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. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1916,10 +2357,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 the 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. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1942,10 +2391,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 the 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. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1968,10 +2425,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 the property name and value (as a JSON string) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -1994,10 +2459,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 the property name and value (as a JSON string) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -2020,10 +2493,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 the property name and value (as a JSON string) as part of a name/value pair of a JSON object. + + + + The specified property name is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -2046,10 +2527,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 the 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. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -2072,10 +2561,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 the 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. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -2098,10 +2595,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 the 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. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -2128,8 +2633,7 @@ The JSON data to be written would be invalid JSON (while validation is enabled). 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). + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -2156,8 +2660,7 @@ The JSON data to be written would be invalid JSON (while validation is enabled). 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). + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -2184,8 +2687,7 @@ The JSON data to be written would be invalid JSON (while validation is enabled). Writes the 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). + The JSON data to be written would be invalid JSON (while validation is enabled). @@ -2207,9 +2709,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 the UTF-8 text value (as a JSON string) as an element of a JSON array. + + + + The specified value is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -2231,9 +2741,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 the UTF-16 text value (as a JSON string) as an element of a JSON array. + + + + The specified value is too large. + When this would result in an invalid JSON to be written (while validation is enabled). @@ -2255,9 +2773,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 the string text value (as a JSON string) as an element of a JSON array. + + + + The specified value is too large. + When this would result in an invalid JSON to be written (while validation is enabled). From aecf3f1171911acdf790d7c97bfe18c78f0d956e Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Wed, 22 May 2019 15:00:06 -0700 Subject: [PATCH 2/3] Incorporated revisions --- xml/System.Text.Json/JsonDocument.xml | 48 +-- .../JsonElement+ArrayEnumerator.xml | 4 +- .../JsonElement+ObjectEnumerator.xml | 6 +- xml/System.Text.Json/JsonElement.xml | 118 ++--- xml/System.Text.Json/JsonProperty.xml | 4 +- xml/System.Text.Json/JsonReaderOptions.xml | 2 +- xml/System.Text.Json/JsonReaderState.xml | 6 +- xml/System.Text.Json/Utf8JsonReader.xml | 88 ++-- xml/System.Text.Json/Utf8JsonWriter.xml | 405 +++++++++--------- 9 files changed, 351 insertions(+), 330 deletions(-) diff --git a/xml/System.Text.Json/JsonDocument.xml b/xml/System.Text.Json/JsonDocument.xml index b82819fa5fa..4eaad6f62af 100644 --- a/xml/System.Text.Json/JsonDocument.xml +++ b/xml/System.Text.Json/JsonDocument.xml @@ -22,7 +22,7 @@ @@ -71,9 +71,9 @@ This class utilizes resources from pooled memory to minimize the garbage collect - JSON text to parse. + The JSON text to parse. Options to control the reader behavior during parsing. - Parse a sequence as UTF-8-encoded text representing a single JSON value into a JsonDocument. + Parses a sequence as UTF-8-encoded text representing a single JSON byte value into a JsonDocument. A JsonDocument representation of the JSON value. - JSON data to parse. + The JSON data to parse. Options to control the reader behavior during parsing. - Parse a as UTF-8-encoded data representing a single JSON value into a JsonDocument. The Stream will be read to completion. + 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. @@ -143,9 +143,9 @@ Because the input is considered to be text, a UTF-8 Byte-Order-Mark (BOM) must n - JSON text to parse. + The JSON text to parse. Options to control the reader behavior during parsing. - Parse memory as UTF-8-encoded text representing a single JSON value into a JsonDocument. + Parses memory as UTF-8-encoded text representing a single JSON byte value into a JsonDocument. A JsonDocument representation of the JSON value. - JSON text to parse. + The JSON text to parse. Options to control the reader behavior during parsing. - Parse text representing a single JSON value into a JsonDocument. + 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 o - JSON text to parse. + The JSON text to parse. Options to control the reader behavior during parsing. - Parse text representing a single JSON value into a JsonDocument. + Parses text representing a single JSON string value into a JsonDocument. A JsonDocument representation of the JSON value. To be added. @@ -253,11 +253,11 @@ The value may be used for the entire lifetime o - JSON data to parse. + The JSON data to parse. Options to control the reader behavior during parsing. The token to monitor for cancellation requests. - Parse a as UTF-8-encoded data representing a single JSON value into a JsonDocument. The Stream will be read to completion. - A Task to produce a JsonDocument representation of the JSON value. + 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. @@ -292,10 +292,9 @@ The value may be used for the entire lifetime o property of `reader` is or , the reader will be advanced by one call to to determine -the start of the value. +If the 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` will be positioned at the final token in the JSON value. If an exception is thrown the reader is reset to +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. @@ -303,7 +302,7 @@ This method makes a copy of the data the reader acted on, so there is no caller ]]> - is using unsupported options. + contains unsupported options. A value could not be read from the reader. @@ -326,7 +325,7 @@ This method makes a copy of the data the reader acted on, so there is no caller System.Text.Json.JsonElement - The representing the value of the document. + Gets the root element of this JSON document. To be added. To be added. @@ -352,17 +351,16 @@ This method makes a copy of the data the reader acted on, so there is no caller The reader to read. - Receives the parsed document. + 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. + 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 be advanced by one call to to determine -the start of the value. +If the 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` will be positioned at the final token in the JSON value. If an exception is thrown, or `false` +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. @@ -370,7 +368,7 @@ This method makes a copy of the data the reader acted on, so there is no caller ]]> - is using unsupported options. + 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 834c6f1c602..2d89d3720ba 100644 --- a/xml/System.Text.Json/JsonElement+ArrayEnumerator.xml +++ b/xml/System.Text.Json/JsonElement+ArrayEnumerator.xml @@ -30,7 +30,7 @@ - An enumerable and enumerator for the contents of a JSON array. + Represents an enumerator for the contents of a JSON array. To be added. @@ -100,7 +100,7 @@ Returns an enumerator that iterates through a collection. - An value that can be used to iterate through the array. + 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 f99d03fe254..dcfde4ad6c3 100644 --- a/xml/System.Text.Json/JsonElement+ObjectEnumerator.xml +++ b/xml/System.Text.Json/JsonElement+ObjectEnumerator.xml @@ -30,7 +30,7 @@ - An enumerable and enumerator for the properties of a JSON object. + Represents an enumerator for the properties of a JSON object. To be added. @@ -100,11 +100,11 @@ Returns an enumerator that iterates the properties of an object. - An value that can be used to iterate through the 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 0d41eddf137..1654accd232 100644 --- a/xml/System.Text.Json/JsonElement.xml +++ b/xml/System.Text.Json/JsonElement.xml @@ -40,12 +40,12 @@ - Get a JsonElement which can be safely stored beyond the lifetime of the original . - A JsonElement which can be safely stored beyond the lifetime of the original . + 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 . @@ -68,7 +68,7 @@ If this JsonElement is itself the output of a previous call to Clone, or a value - Get an enumerator to enumerate the values in the JSON array represented by this JsonElement. + 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 . @@ -92,7 +92,7 @@ If this JsonElement is itself the output of a previous call to Clone, or a value - Get an enumerator to enumerate the properties in the JSON object represented by this JsonElement. + 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 . @@ -116,7 +116,7 @@ If this JsonElement is itself the output of a previous call to Clone, or a value - Get the number of values contained within the current array value. + 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 . @@ -149,7 +149,7 @@ This method does not parse the contents of a JSON string value. ]]> - This value's is neither or . + This value's is neither nor . The parent has been disposed. @@ -270,7 +270,7 @@ This method does not create a DateTimeOffset representation of values other than This method does not parse the contents of a JSON string value. -On .NET Core this method returns (or ) for values larger than (or smaller than ). +On .NET Core, this method returns for values larger than , and it returns for values smaller than . ]]> @@ -352,8 +352,8 @@ This method does not create a Guid representation of values other than JSON stri - Gets the current JSON number as a . - The current JSON number as a . + Gets the current JSON number as an . + The current JSON number as an . - The UTF-8 (with no Byte-Order-Mark (BOM)) representation of the name of the property to return. + 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. @@ -421,15 +421,15 @@ If a property is defined multiple times for the same object, the last such defin - Name of the property whose value to return. + 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. @@ -457,15 +457,15 @@ If a property is defined multiple times for the same object, the last such defin - Name of the property whose value to return. + 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. @@ -492,8 +492,8 @@ If a property is defined multiple times for the same object, the last such defin - Gets the original input data backing this value, returning it as a . - The original input data backing this value, returning it as a . + 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. @@ -522,7 +522,7 @@ If a property is defined multiple times for the same object, the last such defin This method does not parse the contents of a JSON string value. -On .NET Core this method returns (or ) for values larger than (or smaller than ). +On .NET Core, this method returns for values larger than and for values smaller than . ]]> @@ -653,7 +653,7 @@ This method does not parse the contents of a JSON string value. To be added. - Get the value at a specified index when the current value is a . + Gets the value at a specified index when the current value is an . To be added. To be added. This value's is not . @@ -683,15 +683,15 @@ This method does not parse the contents of a JSON string value. , is returned. +For , is returned. -For , is returned. +For , is returned. -For , is returned. +For , is returned. -For , the value of () is returned. +For , the value of is returned. -For other types, the value of () is returned. +For other types, the value of is returned. ]]> @@ -717,7 +717,7 @@ For other types, the value of () - Receives the value. + 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. @@ -750,7 +750,7 @@ This method does not create a DateTime representation of values other than JSON - Receives the value. + 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. @@ -783,7 +783,7 @@ This method does not create a DateTimeOffset representation of values other than - Receives the value. + 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. @@ -816,7 +816,7 @@ This method does not parse the contents of a JSON string value. - Receives the value. + 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. @@ -824,7 +824,7 @@ This method does not parse the contents of a JSON string value. This method does not parse the contents of a JSON string value. -On .NET Core this method does not return for values larger than (or smaller than ), instead and assigns or to `value`. ]]> @@ -851,7 +851,7 @@ On .NET Core this method does not return for values lar - Receives the value. + 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. @@ -884,7 +884,7 @@ This method does not create a Guid representation of values other than JSON stri - Receives the value. + 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. @@ -917,7 +917,7 @@ This method does not parse the contents of a JSON string value. - Receives the value. + 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. @@ -953,14 +953,14 @@ This method does not parse the contents of a JSON string value. 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 whether or not such a property existed. When the property exists is assigned to the value of that 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. @@ -988,16 +988,16 @@ If a property is defined multiple times for the same object, the last such defin - Name of the property to find. - Receives the value of the located property. - Looks for a property named in the current object, returning whether or not such a property existed. When the property exists is assigned to the value of that property. + 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. @@ -1025,16 +1025,16 @@ If a property is defined multiple times for the same object, the last such defin - Name of the property to find. - Receives the value of the located property. - Looks for a property named in the current object, returning whether or not such a property existed. When the property exists is assigned to the value of that property. + 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. @@ -1062,7 +1062,7 @@ If a property is defined multiple times for the same object, the last such defin - Receives the value. + 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. @@ -1070,7 +1070,7 @@ If a property is defined multiple times for the same object, the last such defin This method does not parse the contents of a JSON string value. -On .NET Core this method does not return `false` for values larger than (or smaller than ), instead `false` is returned and (or ) is emitted. +On .NET Core, this method does not return `false` for values larger than or smaller than ). Instead, it returns `false` and assigns or to the `value` argument. ]]> @@ -1102,7 +1102,7 @@ On .NET Core this method does not return `false` for values larger than - Receives the value. + 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. @@ -1140,7 +1140,7 @@ This method does not parse the contents of a JSON string value. - Receives the value. + 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. @@ -1170,7 +1170,7 @@ This method does not parse the contents of a JSON string value. System.Text.Json.JsonValueType - The that the value is. + Gets the type of the current JSON element. To be added. To be added. The parent has been disposed. @@ -1196,9 +1196,9 @@ This method does not parse the contents of a JSON string value. - The name for this value within the JSON object, as UTF-8 text. + UTF8-encoded text that represents te name for this value within the JSON object. The writer. - Write the element into the provided writer as a named object property. + 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. @@ -1224,9 +1224,9 @@ This method does not parse the contents of a JSON string value. - The name for this value within the JSON object. + A character span that specifies the name for this value within the JSON object. The writer. - Write the element into the provided writer as a named object property. + 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. @@ -1252,7 +1252,7 @@ This method does not parse the contents of a JSON string value. The writer. - Write the element into the provided writer as a value. + 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 5a90597d3d0..0c997dc4e07 100644 --- a/xml/System.Text.Json/JsonProperty.xml +++ b/xml/System.Text.Json/JsonProperty.xml @@ -61,8 +61,8 @@ - Provides a representation of the property for debugging purposes. - A string containing the un-interpreted value of the property, beginning at the declaring open-quote and ending at the last character that is part of the value. + 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. diff --git a/xml/System.Text.Json/JsonReaderOptions.xml b/xml/System.Text.Json/JsonReaderOptions.xml index a4d2fc7c3b4..23944419d97 100644 --- a/xml/System.Text.Json/JsonReaderOptions.xml +++ b/xml/System.Text.Json/JsonReaderOptions.xml @@ -34,7 +34,7 @@ System.Boolean - 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 is thrown if a trailing comma is encountered. + 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. diff --git a/xml/System.Text.Json/JsonReaderState.xml b/xml/System.Text.Json/JsonReaderState.xml index 5d20f93ff5d..09b17cefa2e 100644 --- a/xml/System.Text.Json/JsonReaderState.xml +++ b/xml/System.Text.Json/JsonReaderState.xml @@ -43,16 +43,16 @@ this type can survive across async/await boundaries, and hence it's required to - Defines the customized behavior of the that is different from the JSON RFC (for example how to handle comments or maximum depth allowed when reading). By default, the follows the JSON RFC strictly (i.e. comments within the JSON are invalid) and reads up to a maximum depth of 64. + 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. ctor 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 . +An instance of this state must be passed to the 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 . ]]> - Thrown when the max depth is set to a non-positive value (< 0). + The maximum depth is set to a non-positive value (< 0). diff --git a/xml/System.Text.Json/Utf8JsonReader.xml b/xml/System.Text.Json/Utf8JsonReader.xml index 8e188558d6a..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. ]]> @@ -211,7 +213,7 @@ 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 . 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 ). @@ -232,11 +234,11 @@ in more data asynchronously before continuing with a new instance of the - Reads the next JSON token value from the source and parses it to a . Returns the value if the entire UTF-8 encoded token value can be successfully parsed to a value. Throws exceptions otherwise. - 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. - Thrown if trying to get the value of a JSON token that is not a . - Thrown if the JSON token value is of an unsupported format. Only a subset of ISO 8601 formats are supported. + 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,11 +258,11 @@ in more data asynchronously before continuing with a new instance of the - Reads the next JSON token value from the source and parses it to a . Returns the value if the entire UTF-8 encoded token value can be successfully parsed to a value. Throws exceptions otherwise. - 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. - Thrown if trying to get the value of a JSON token that is not a . - Thrown if the JSON token value is of an unsupported format. Only a subset of ISO 8601 formats are supported. + 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. @@ -346,11 +348,11 @@ The `GetDouble` method throws an exception if the entire UTF-8 encoded token val - Reads the next JSON token value from the source and parses it to a . Returns the value if the entire UTF-8 encoded token value can be successfully parsed to a value. Throws exceptions otherwise. - 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. - Thrown if trying to get the value of a JSON token that is not a . - Thrown if the JSON token value is of an unsupported format for a Guid. + The value of the JSON token isn't a . + The JSON token value is in an unsupported format for a Guid. @@ -382,7 +384,7 @@ 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 is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation. - or- @@ -419,7 +421,7 @@ 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 is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation. - or- @@ -514,7 +516,7 @@ The JSON string contains invalid UTF-8 bytes or invalid UTF-16 surrogates.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 is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation. - or- @@ -548,7 +550,7 @@ The JSON token value represents a number less than . 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 is of the incorrect numeric format. For example, it contains a decimal or is written in scientific notation. - or- @@ -629,12 +631,16 @@ 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, . 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. - Thrown when an invalid JSON token is encountered according to the JSON RFC or if the current depth exceeds the recursive limit set by the max 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. @@ -657,8 +663,8 @@ The current depth exceeds the recursive limit set by the maximum depth. 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 true if they match. - True if the JSON token value in the source matches the UTF-8 encoded look up text. + 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, . - Thrown if trying to find a text match on a JSON token that is not a string (i.e. other than or ). + The JSON token isn't a string (that is, its type is other than or ). @@ -690,15 +696,15 @@ If the look up text is invalid UTF-8 text, the method will return `false` since 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. - True if the JSON token value in the source matches the UTF-16 encoded look up text. + if the JSON token value in the source matches the UTF-16 encoded look up text; otherwise, . - Thrown if trying to find a text match on a JSON token that is not a string (i.e. other than or ). + The JSON text isn't a string (its type is not or ). @@ -741,11 +747,11 @@ If the look up text is invalid or incomplete UTF-16 text (i.e. unpaired surrogat - To be added. - Reads the next JSON token value from the source and parses it to a . Returns if the entire UTF-8 encoded token value can be successfully parsed to a value. Returns otherwise. - 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. - Thrown if trying to get the value of a JSON token that is not a . + The value of the JSON token isn't a . @@ -767,11 +773,11 @@ If the look up text is invalid or incomplete UTF-16 text (i.e. unpaired surrogat - To be added. - Reads the next JSON token value from the source and parses it to a . Returns if the entire UTF-8 encoded token value can be successfully parsed to a value. Returns otherwise." - 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. - Thrown if trying to get the value of a JSON token that is not a . + The value of the JSON token isn't a . @@ -847,11 +853,17 @@ If the look up text is invalid or incomplete UTF-16 text (i.e. unpaired surrogat - To be added. - Reads the next JSON token value from the source and parses it to a . Returns if the entire UTF-8 encoded token value can be successfully parsed to a value. Only supports values with hyphens and without any surrounding decorations. Returns otherwise. - To be added. - To be added. - Thrown if trying to get the value of a JSON token that is not a . + 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 . diff --git a/xml/System.Text.Json/Utf8JsonWriter.xml b/xml/System.Text.Json/Utf8JsonWriter.xml index d0708d713e4..5a8944c81cc 100644 --- a/xml/System.Text.Json/Utf8JsonWriter.xml +++ b/xml/System.Text.Json/Utf8JsonWriter.xml @@ -54,11 +54,11 @@ To be able to format the output with indentation and white space OR to skip vali - An instance of used as a destination for writing JSON text into. - Defines the customized behavior of the By default, the writes JSON minimized (i.e. with no extra whitespace) and validates that the JSON being written is structurally valid according to JSON RFC. - Constructs a new instance with a specified . + 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. - The instance of that is passed in is . + is . @@ -77,11 +77,11 @@ To be able to format the output with indentation and white space OR to skip vali - An instance of used as a destination for writing JSON text into. - Defines the customized behavior of the By default, the writes JSON minimized (i.e. with no extra whitespace) and validates that the JSON being written is structurally valid according to JSON RFC. + 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. - The instance of that is passed in is . + is . @@ -100,15 +100,14 @@ 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. , this property indicates how much the IBufferWriter has advanced. -In the case of Stream, this is how much data has been written to the stream. +In the case of a , this property indicates how much data has been written to the stream. ]]> @@ -130,7 +129,7 @@ In the case of Stream, this is how much data has been written to the stream. System.Int32 - Returns the amount of bytes written by the so far that have not yet been flushed to the output and committed. + 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. @@ -184,11 +183,11 @@ The `CurrentDepth` property tracks the recursive depth of the nested objects / a - Commits any left over JSON text that has not yet been flushed and releases all resources used by the current instance. + 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 IBufferWriter, this advances the underlying based on what has been written so far. In the case of Stream, this writes the data to the stream and flushes it. @@ -216,12 +215,12 @@ In the case of Stream, this writes the data to the stream and flushes it. - Asynchronously commits any left over JSON text that has not yet been flushed and releases all resources used by the current instance. + Asynchronously commits any leftover JSON text that has not yet been flushed and releases all resources used by the current instance. To be added. based on what has been written so far. +In the case of IBufferWriter, this advances the underlying based on what has been written so far. In the case of Stream, this writes the data to the stream and flushes it. @@ -246,17 +245,17 @@ In the case of Stream, this writes the data to the stream and flushes it. - Commits the JSON text written so far which makes it visible to the output destination. + 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 IBufferWriter, this advances the underlying based on what has been written so far. -In the case of Stream, this writes the data to the stream and flushes it. +In the case of , this writes the data to the stream and flushes it. ]]> - The instance of has been disposed. + This instance has been disposed. @@ -277,18 +276,18 @@ In the case of Stream, this writes the data to the stream and flushes it. To be added. - Asynchronously commits the JSON text written so far which makes it visible to the output destination. + Asynchronously commits the JSON text written so far, which makes it visible to the output destination. To be added. based on what has been written so far. +In the case of IBufferWriter, this advances the underlying based on what has been written so far. -In the case of Stream, this writes the data to the stream and flushes it asynchronously, while monitoring cancellation requests. +In the case of , this writes the data to the stream and flushes it asynchronously, while monitoring cancellation requests. ]]> - The instance of has been disposed. + This instance has been disposed. @@ -307,7 +306,7 @@ In the case of Stream, this writes the data to the stream and flushes it asynchr System.Text.Json.JsonWriterOptions - Gets the custom behavior when writing JSON using the which indicates whether to format the output while writing and whether to skip structural JSON validation or not. + 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. @@ -329,15 +328,15 @@ In the case of Stream, this writes the data to the stream and flushes it asynchr - Resets the internal state so that it can be re-used. + 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 as the destination (either or ). +The will continue to use the original writer options and the original output (either or ) as the destination. ]]> - The instance of has been disposed. + This instance has been disposed. @@ -359,17 +358,17 @@ The will continue to use the original w - An instance of used as a destination for writing JSON text into. - Resets the internal state so that it can be re-used with the new instance of . + 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 the passed in as the new destination. +The will continue to use the original writer options but now writes to `bufferWriter` as the new destination. ]]> - The instance of that is passed in is . - The instance of has been disposed. + is . + This instance has been disposed. @@ -391,17 +390,17 @@ The will continue to use the original w - An instance of used as a destination for writing JSON text into. - Resets the internal state so that it can be re-used with the new instance of . + 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 the passed in as the new destination. +The will continue to use the original writer options but now write to `utf8Json` as the new destination. ]]> - The instance of that is passed in is . - The instance of has been disposed. + is . + This instance has been disposed. @@ -426,7 +425,7 @@ The will continue to use the original w 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 the property name and value (as a JSON literal "true" or "false") as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the operation would result in writing invalid JSON. @@ -460,7 +459,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON literal "true" or "false") as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the operation would result in writing invalid JSON. @@ -494,7 +493,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON literal "true" or "false") as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the operation would result in writing invalid JSON. @@ -526,9 +525,9 @@ The property name is escaped before writing. 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. @@ -551,7 +550,7 @@ The property name is escaped before writing. The UTF-8 encoded value to be written as a JSON comment within /*..*/. - Writes the UTF-8 text value (as a JSON comment). + Writes a UTF-8 text value as a JSON comment. - The specified value is too large OR if the given UTF-8 text value contains a comment delimiter (i.e. */). + The specified value is too large. + +-or- + + contains a comment delimiter (i.e. */). @@ -582,7 +585,7 @@ The comment value is not escaped before writing. The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within /*..*/. - Writes the UTF-16 text value (as a JSON comment). + Writes a UTF-16 text value as a JSON comment. - The specified value is too large OR if the given UTF-16 text value contains a comment delimiter (i.e. */). + The specified value is too large OR. + +-or- + + contains a comment delimiter (i.e. */). @@ -613,7 +620,7 @@ The comment value is not escaped before writing. The UTF-16 encoded value to be written as a UTF-8 transcoded JSON comment within /*..*/. - Writes the string text value (as a JSON comment). + Writes a string text value as a JSON comment. - The specified value is too large OR if the given string text value contains a comment delimiter (i.e. */). + The specified value is too large. + +-or- + + contains a comment delimiter (i.e. */). @@ -643,7 +654,7 @@ The comment value is not escaped before writing. 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. @@ -665,7 +676,7 @@ The comment value is not escaped before writing. 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. @@ -688,7 +699,7 @@ The comment value is not escaped before writing. The UTF-8 encoded property name of the JSON object to be written. - Writes the property name and the JSON literal "null" as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -720,7 +731,7 @@ The property name is escaped before writing. The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - Writes the property name and the JSON literal "null" as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -752,7 +763,7 @@ The property name is escaped before writing. The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8. - Writes the property name and the JSON literal "null" as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -783,7 +794,7 @@ The property name is escaped before writing. 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. @@ -808,7 +819,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -842,7 +853,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -876,7 +887,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -910,7 +921,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -944,7 +955,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -983,7 +994,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -1022,7 +1033,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -1056,7 +1067,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -1090,7 +1101,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -1124,7 +1135,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -1158,7 +1169,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -1192,7 +1203,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -1231,7 +1242,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -1270,7 +1281,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -1304,7 +1315,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -1338,7 +1349,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -1372,7 +1383,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -1406,7 +1417,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -1440,7 +1451,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -1479,7 +1490,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -1518,7 +1529,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON number) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -1550,11 +1561,11 @@ The property name is escaped before writing. 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. @@ -1577,11 +1588,11 @@ The property name is escaped before writing. 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. @@ -1604,11 +1615,11 @@ The property name is escaped before writing. 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. @@ -1631,11 +1642,11 @@ The property name is escaped before writing. 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. @@ -1658,11 +1669,11 @@ The property name is escaped before writing. 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. @@ -1690,11 +1701,11 @@ The property name is escaped before writing. 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. @@ -1722,11 +1733,11 @@ The property name is escaped before writing. 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. @@ -1748,11 +1759,11 @@ The property name is escaped before writing. 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. @@ -1775,7 +1786,7 @@ if this would result in an invalid JSON to be written (while validation is enabl The UTF-8 encoded property name of the JSON array to be written. - Writes the beginning of a JSON array with a property name as the key. + 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 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. @@ -1811,7 +1822,7 @@ if this would result in an invalid JSON to be written (while validation is enabl 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 as the key. + 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 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. @@ -1847,7 +1858,7 @@ if this would result in an invalid JSON to be written (while validation is enabl 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 as the key. + 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 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. @@ -1882,11 +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. @@ -1909,7 +1920,7 @@ The JSON data to be written would be invalid JSON (while validation is enabled). The UTF-8 encoded property name of the JSON object to be written. - Writes the beginning of a JSON object with a property name as the key. + 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 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. @@ -1945,7 +1956,7 @@ if this would result in an invalid JSON to be written (while validation is enabl 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 as the key. + 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 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. @@ -1981,7 +1992,7 @@ if this would result in an invalid JSON to be written (while validation is enabl 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 as the key. + 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 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. @@ -2019,7 +2030,7 @@ if this would result in an invalid JSON to be written (while validation is enabl 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 the property name and value (as a JSON string) as part of a name/value pair of a JSON object. + Writes a property name specified as a read-only span of bytes 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -2053,7 +2064,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON string) as part of a name/value pair of a JSON object. + Writes a property name specified as a read-only span of bytes 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -2087,7 +2098,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON string) as part of a name/value pair of a JSON object. + Writes a property name specified as a read-only span of bytes 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -2121,7 +2132,7 @@ The property name is escaped before writing. 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 the UTF-8 property name and UTF-8 text value (as a JSON string) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -2155,7 +2166,7 @@ The property name and value is escaped before writing. 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 the UTF-8 property name and UTF-16 text value (as a JSON string) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -2189,7 +2200,7 @@ The property name and value is escaped before writing. 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 the UTF-8 property name and string text value (as a JSON string) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -2223,7 +2234,7 @@ The property name and value is escaped before writing. 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 the property name and value (as a JSON string) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -2257,7 +2268,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON string) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -2291,7 +2302,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON string) as part of a name/value pair of a JSON object. + Writes a property name 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -2325,7 +2336,7 @@ The property name is escaped before writing. 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 the UTF-16 property name and UTF-8 text value (as a JSON string) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -2359,7 +2370,7 @@ The property name and value is escaped before writing. 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 the UTF-16 property name and UTF-16 text value (as a JSON string) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -2393,7 +2404,7 @@ The property name and value is escaped before writing. 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 the UTF-16 property name and string text value (as a JSON string) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -2427,7 +2438,7 @@ The property name and value is escaped before writing. 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 the property name and value (as a JSON string) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -2461,7 +2472,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON string) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -2495,7 +2506,7 @@ The property name is escaped before writing. 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 the property name and value (as a JSON string) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -2529,7 +2540,7 @@ The property name is escaped before writing. 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 the property name and UTF-8 text value (as a JSON string) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -2563,7 +2574,7 @@ The property name and value is escaped before writing. 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 the property name and UTF-16 text value (as a JSON string) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -2597,7 +2608,7 @@ The property name and value is escaped before writing. 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 the property name and string text value (as a JSON string) as part of a name/value pair of a JSON object. + 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -2629,11 +2640,11 @@ The property name and value is escaped before writing. 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. @@ -2656,11 +2667,11 @@ The property name and value is escaped before writing. 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. @@ -2683,11 +2694,11 @@ The property name and value is escaped before writing. 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. @@ -2710,7 +2721,7 @@ The property name and value is escaped before writing. The UTF-8 encoded value to be written as a JSON string element of a JSON array. - Writes the UTF-8 text value (as a JSON string) as an 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -2742,7 +2753,7 @@ The value is escaped before writing. The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array. - Writes the UTF-16 text value (as a JSON string) as an 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. @@ -2774,7 +2785,7 @@ The value is escaped before writing. The UTF-16 encoded value to be written as a UTF-8 transcoded JSON string element of a JSON array. - Writes the string text value (as a JSON string) as an 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. - When this would result in an invalid JSON to be written (while validation is enabled). + Validation is enabled, and the write operation would produce invalid JSON. From 1b19c683102610fc780d037028168004e121c80a Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Wed, 22 May 2019 15:02:21 -0700 Subject: [PATCH 3/3] Additional change --- xml/System.Text.Json/Utf8JsonWriter.xml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/xml/System.Text.Json/Utf8JsonWriter.xml b/xml/System.Text.Json/Utf8JsonWriter.xml index 5a8944c81cc..deb29b50052 100644 --- a/xml/System.Text.Json/Utf8JsonWriter.xml +++ b/xml/System.Text.Json/Utf8JsonWriter.xml @@ -2030,7 +2030,7 @@ Validation is enabled, and this write operation would produce invalid JSON. 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 property name specified as a read-only span of bytes and a value (as a JSON string) as part of a name/value pair of a JSON object. + 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 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 property name specified as a read-only span of bytes and a value (as a JSON string) as part of a name/value pair of a JSON object. + 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 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 property name specified as a read-only span of bytes and a value (as a JSON string) as part of a name/value pair of a JSON object. + 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 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 as a read-only character span and a value (as a JSON string) as part of a name/value pair of a JSON object. + 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 value to be written 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. - This method 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. Validation is enabled, and the operation would result in writing invalid JSON.