-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Copy pathJsonReaderState.xml
108 lines (103 loc) · 6.95 KB
/
JsonReaderState.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
<Type Name="JsonReaderState" FullName="System.Text.Json.JsonReaderState">
<TypeSignature Language="C#" Value="public readonly struct JsonReaderState" FrameworkAlternate="net-10.0;net-10.0-pp;net-8.0-pp;net-9.0;net-9.0-pp;netframework-4.6.2-pp;netstandard-2.0-pp" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit JsonReaderState extends System.ValueType" />
<TypeSignature Language="DocId" Value="T:System.Text.Json.JsonReaderState" />
<TypeSignature Language="VB.NET" Value="Public Structure JsonReaderState" />
<TypeSignature Language="F#" Value="type JsonReaderState = struct" />
<TypeSignature Language="C++ CLI" Value="public value class JsonReaderState" />
<TypeSignature Language="C#" Value="public struct JsonReaderState" FrameworkAlternate="net-5.0;net-6.0;net-7.0;net-8.0;netcore-3.0;netcore-3.1" />
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="net-10.0;net-10.0-pp;net-8.0-pp;net-9.0;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.IsReadOnly>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Defines an opaque type that holds and saves all the relevant state information, which must be provided to the <see cref="T:System.Text.Json.Utf8JsonReader" /> to continue reading after processing incomplete data.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
`JsonReaderState` is required to support reentrancy when reading incomplete data, and to continue reading once more data is available.
Unlike the <xref:System.Text.Json.Utf8JsonReader> struct, which is a ref struct,
this type can survive across async/await boundaries, and hence it's required to provide support for reading more data asynchronously before continuing with a new instance of the <xref:System.Text.Json.Utf8JsonReader>.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public JsonReaderState (System.Text.Json.JsonReaderOptions options = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Text.Json.JsonReaderOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.JsonReaderState.#ctor(System.Text.Json.JsonReaderOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional options As JsonReaderOptions = Nothing)" />
<MemberSignature Language="F#" Value="new System.Text.Json.JsonReaderState : System.Text.Json.JsonReaderOptions -> System.Text.Json.JsonReaderState" Usage="new System.Text.Json.JsonReaderState options" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="options" Type="System.Text.Json.JsonReaderOptions" />
</Parameters>
<Docs>
<param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonReader" /> that is different from the JSON RFC (for example how to handle comments, or the maximum depth allowed when reading). By default, the <see cref="T:System.Text.Json.Utf8JsonReader" /> follows the JSON RFC strictly (comments within the JSON are invalid) and reads up to a maximum depth of 64.</param>
<summary>Constructs a new <see cref="T:System.Text.Json.JsonReaderState" /> instance.</summary>
<remarks>
<format><![CDATA[
An instance of this state must be passed to the <xref:System.Text.Json.Utf8JsonReader> constructor with the JSON data. Unlike the <xref:System.Text.Json.Utf8JsonReader>, 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 <xref:System.Text.Json.Utf8JsonReader>.
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">The maximum depth is set to a non-positive value (< 0).</exception>
</Docs>
</Member>
<Member MemberName="Options">
<MemberSignature Language="C#" Value="public System.Text.Json.JsonReaderOptions Options { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Text.Json.JsonReaderOptions Options" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.JsonReaderState.Options" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Options As JsonReaderOptions" />
<MemberSignature Language="F#" Value="member this.Options : System.Text.Json.JsonReaderOptions" Usage="System.Text.Json.JsonReaderState.Options" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Text::Json::JsonReaderOptions Options { System::Text::Json::JsonReaderOptions get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Text.Json.JsonReaderOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the custom behavior to use when reading JSON data using the <see cref="T:System.Text.Json.Utf8JsonReader" /> struct that may deviate from strict adherence to the JSON specification, which is the default behavior.</summary>
<value>The custom behavior to use when reading JSON data.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>