You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: xml/System.Text.Json/Utf8JsonReader.xml
+26-18Lines changed: 26 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -667,8 +667,8 @@ For input data within a `ReadOnlySpan<byte>`, this always returns `false`. For i
667
667
<ReturnType>System.Boolean</ReturnType>
668
668
</ReturnValue>
669
669
<Docs>
670
-
<summary>Returns the mode of this instance of the <seecref="T:System.Text.Json.Utf8JsonReader" />.</summary>
671
-
<value><seelangword="true" /> when the reader was constructed with the input span containing the entire data to process. <seelangword="false" /> when the reader was constructed knowing that the input span may contain partial data with more data to follow.</value>
670
+
<summary>Gets the mode of this instance of the <seecref="T:System.Text.Json.Utf8JsonReader" />.</summary>
671
+
<value><seelangword="true" /> if the reader was constructed with the input span containing the entire data to process. <seelangword="false" /> if the reader was constructed with an input span that may contain partial data with more data to follow.</value>
672
672
<remarks>To be added.</remarks>
673
673
</Docs>
674
674
</Member>
@@ -745,17 +745,21 @@ The current depth exceeds the recursive limit set by the maximum depth.</excepti
745
745
746
746
## Remarks
747
747
748
-
When <xref:System.Text.Json.Utf8JsonReader.TokenType> is <xref:System.Text.Json.JsonTokenType.PropertyName>, the reader first moves to the property value.
748
+
When <xref:System.Text.Json.Utf8JsonReader.TokenType> is <xref:System.Text.Json.JsonTokenType.PropertyName?displayProperty=nameWithType>, the reader first moves to the property value.
749
749
750
-
When <xref:System.Text.Json.Utf8JsonReader.TokenType> (originally, or after advancing) is <xref:System.Text.Json.JsonTokenType.StartObject> or <xref:System.Text.Json.JsonTokenType.StartArray>, the reader advances to the matching <xref:System.Text.Json.JsonTokenType.EndObject> or <xref:System.Text.Json.JsonTokenType.EndArray>.
750
+
When <xref:System.Text.Json.Utf8JsonReader.TokenType> (originally, or after advancing) is <xref:System.Text.Json.JsonTokenType.StartObject?displayProperty=nameWithtype> or <xref:System.Text.Json.JsonTokenType.StartArray?displayProperty=nameWithType>, the reader advances to the matching <xref:System.Text.Json.JsonTokenType.EndObject?displayProperty=nameWithType> or <xref:System.Text.Json.JsonTokenType.EndArray?displayProperty=nameWithType>.
751
751
752
752
For all other token types, the reader does not move. After the next call to <xref:System.Text.Json.Utf8JsonReader.Read>, the reader will be at the next value (when in an array), the next property name (when in an object), or the end array/object token.
753
753
754
754
]]>
755
755
</format>
756
756
</remarks>
757
-
<exceptioncref="T:System.InvalidOperationException">Thrown when the reader was given partial data with more data to follow (i.e. <seecref="P:System.Text.Json.Utf8JsonReader.IsFinalBlock" /> is false).</exception>
758
-
<exceptioncref="T:System.Text.Json.JsonException">Thrown when an invalid JSON token is encountered while skipping, according to the JSON RFC, or if the current depth exceeds the recursive limit set by the max depth.</exception>
757
+
<exceptioncref="T:System.InvalidOperationException">The reader was given partial data with more data to follow (that is, <seecref="P:System.Text.Json.Utf8JsonReader.IsFinalBlock" /> is <seelangword="false" />).</exception>
758
+
<exceptioncref="T:System.Text.Json.JsonException">An invalid JSON token was encountered while skipping, according to the JSON RFC.
759
+
760
+
- or -
761
+
762
+
The current depth exceeds the recursive limit set by the maximum depth.</exception>
759
763
</Docs>
760
764
</Member>
761
765
<MemberMemberName="TextEquals">
@@ -840,17 +844,17 @@ If the look up text is invalid or incomplete UTF-16 text (such as unpaired surro
840
844
<ReturnType>System.Int64</ReturnType>
841
845
</ReturnValue>
842
846
<Docs>
843
-
<summary>Returns the index that the last processed JSON token starts at within the given UTF-8 encoded input text, skipping any white space.</summary>
844
-
<value>To be added.</value>
847
+
<summary>Gets the index that the last processed JSON token within the given UTF-8 encoded input text starts at, skipping any white space.</summary>
848
+
<value>The starting index of the last processed JSON token within the given UTF-8 encoded input text.</value>
845
849
<remarks>
846
850
<formattype="text/markdown">
847
851
<![CDATA[
848
852
849
853
## Remarks
850
854
851
-
For JSON strings (including property names), this points to before the start quote.
855
+
For JSON strings (including property names), this value points to before the start quote.
852
856
853
-
For comments, this points to before the first comment delimiter (i.e. '/').
857
+
For comments, this value points to before the first comment delimiter (that is, '/').
854
858
855
859
]]>
856
860
</format>
@@ -897,11 +901,11 @@ For comments, this points to before the first comment delimiter (i.e. '/').
<summary>Parses the current JSON token value from the source and decodes the base 64 encoded JSON string as bytes.</summary>
902
-
<returns><seelangword="true" /> if the entire token value is encoded as valid base 64 text and can be successfully decoded to bytes, <seelangword="false" /> otherwise.</returns>
904
+
<paramname="value">When the method returns, a byte array that contains the base 64-encoded JSON string if the method succeeds.</param>
905
+
<summary>Tries to parse the current JSON token value from the source and decodes the base 64 encoded JSON string as a byte array.</summary>
906
+
<returns><seelangword="true" /> if the entire token value is encoded as valid base 64 text and can be successfully decoded; <seelangword="false" /> otherwise.</returns>
903
907
<remarks>To be added.</remarks>
904
-
<exceptioncref="T:System.InvalidOperationException">Thrown if trying to get the value of a JSON token that is not a <seecref="F:System.Text.Json.JsonTokenType.String" />. <seealsocref="P:System.Text.Json.Utf8JsonReader.TokenType" />.</exception>
908
+
<exceptioncref="T:System.InvalidOperationException">The JSON token is not a <seecref="F:System.Text.Json.JsonTokenType.String" />.</exception>
905
909
</Docs>
906
910
</Member>
907
911
<MemberMemberName="TryGetDateTime">
@@ -1218,7 +1222,7 @@ This method only parses <xref:System.Guid> values with hyphens and without any s
1218
1222
<Docs>
1219
1223
<summary>Tries to skip the children of the current JSON token.</summary>
1220
1224
<returns>
1221
-
<seelangword="true" /> if there was enough data for the children to be skipped successfully, else <seelangword="false" />.</returns>
1225
+
<seelangword="true" /> if there was enough data for the children to be skipped successfully; otherwise, <seelangword="false" />.</returns>
1222
1226
<remarks>
1223
1227
<formattype="text/markdown">
1224
1228
<![CDATA[
@@ -1227,15 +1231,19 @@ This method only parses <xref:System.Guid> values with hyphens and without any s
1227
1231
1228
1232
If the reader did not have enough data to completely skip the children of the current token, it will be reset to the state it was in before the method was called.
1229
1233
1230
-
When <xref:System.Text.Json.Utf8JsonReader.TokenType> is <xref:System.Text.Json.JsonTokenType.PropertyName>, the reader first moves to the property value.
1234
+
When <xref:System.Text.Json.Utf8JsonReader.TokenType> is <xref:System.Text.Json.JsonTokenType.PropertyName?displayProperty=nameWithType>, the reader first moves to the property value.
1231
1235
1232
-
When <xref:System.Text.Json.Utf8JsonReader.TokenType> (originally, or after advancing) is <xref:System.Text.Json.JsonTokenType.StartObject> or <xref:System.Text.Json.JsonTokenType.StartArray>, the reader advances to the matching <xref:System.Text.Json.JsonTokenType.EndObject> or <xref:System.Text.Json.JsonTokenType.EndArray>.
1236
+
When <xref:System.Text.Json.Utf8JsonReader.TokenType> (originally, or after advancing) is <xref:System.Text.Json.JsonTokenType.StartObject?displayProperty=nameWithType> or <xref:System.Text.Json.JsonTokenType.StartArray?displayProperty=nameWithType>, the reader advances to the matching <xref:System.Text.Json.JsonTokenType.EndObject?displayProperty=nameWithType> or <xref:System.Text.Json.JsonTokenType.EndArray?displayProperty=nameWithType>.
1233
1237
1234
1238
For all other token types, the reader does not move. After the next call to <xref:System.Text.Json.Utf8JsonReader.Read>, the reader will be at the next value (when in an array), the next property name (when in an object), or the end array/object token.
1235
1239
1236
1240
]]></format>
1237
1241
</remarks>
1238
-
<exceptioncref="T:System.Text.Json.JsonException">Thrown when an invalid JSON token is encountered while skipping, according to the JSON RFC, or if the current depth exceeds the recursive limit set by the max depth.</exception>
1242
+
<exceptioncref="T:System.Text.Json.JsonException">An invalid JSON token was encountered while skipping, according to the JSON RFC.
1243
+
1244
+
- or -
1245
+
1246
+
The current depth exceeds the recursive limit set by the maximum depth.</exception>
0 commit comments