-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Copy pathJsonProperty.xml
292 lines (283 loc) · 16.5 KB
/
JsonProperty.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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
<Type Name="JsonProperty" FullName="System.Text.Json.JsonProperty">
<TypeSignature Language="C#" Value="public readonly struct JsonProperty" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit JsonProperty extends System.ValueType" />
<TypeSignature Language="DocId" Value="T:System.Text.Json.JsonProperty" />
<TypeSignature Language="VB.NET" Value="Public Structure JsonProperty" />
<TypeSignature Language="F#" Value="type JsonProperty = struct" />
<TypeSignature Language="C++ CLI" Value="public value class JsonProperty" />
<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-5.0;net-6.0;net-7.0;net-8.0;net-8.0-pp;net-9.0;net-9.0-pp;netcore-3.0;netcore-3.1">
<AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.IsReadOnly>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-10.0;net-10.0-pp;net-8.0;net-8.0-pp;net-9.0;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp;netframework-4.6.2-pp;netstandard-2.0-pp">
<AttributeName Language="C#">[System.Diagnostics.DebuggerDisplay("{DebuggerDisplay,nq}")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.DebuggerDisplay("{DebuggerDisplay,nq}")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents a single property for a JSON object.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.JsonProperty.Name" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string" Usage="System.Text.Json.JsonProperty.Name" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Name { System::String ^ 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.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the name of this property.</summary>
<value>The name of this property.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NameEquals">
<MemberSignature Language="C#" Value="public bool NameEquals (ReadOnlySpan<byte> utf8Text);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool NameEquals(valuetype System.ReadOnlySpan`1<unsigned int8> utf8Text) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.JsonProperty.NameEquals(System.ReadOnlySpan{System.Byte})" />
<MemberSignature Language="VB.NET" Value="Public Function NameEquals (utf8Text As ReadOnlySpan(Of Byte)) As Boolean" />
<MemberSignature Language="F#" Value="member this.NameEquals : ReadOnlySpan<byte> -> bool" Usage="jsonProperty.NameEquals utf8Text" />
<MemberSignature Language="C++ CLI" Value="public:
 bool NameEquals(ReadOnlySpan<System::Byte> utf8Text);" />
<MemberType>Method</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.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="utf8Text" Type="System.ReadOnlySpan<System.Byte>" />
</Parameters>
<Docs>
<param name="utf8Text">The UTF-8 encoded text to compare against.</param>
<summary>Compares the specified UTF-8 encoded text to the name of this property.</summary>
<returns>
<see langword="true" /> if the name of this property has the same UTF-8 encoding as <paramref name="utf8Text" />; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method is functionally equal to doing an ordinal comparison of `utf8Text` and <xref:System.Text.Json.JsonProperty.Name>, but it can avoid creating the string instance.
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">This value's <see cref="T:System.Type" /> is not <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />.</exception>
</Docs>
</Member>
<Member MemberName="NameEquals">
<MemberSignature Language="C#" Value="public bool NameEquals (ReadOnlySpan<char> text);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool NameEquals(valuetype System.ReadOnlySpan`1<char> text) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.JsonProperty.NameEquals(System.ReadOnlySpan{System.Char})" />
<MemberSignature Language="VB.NET" Value="Public Function NameEquals (text As ReadOnlySpan(Of Char)) As Boolean" />
<MemberSignature Language="F#" Value="member this.NameEquals : ReadOnlySpan<char> -> bool" Usage="jsonProperty.NameEquals text" />
<MemberSignature Language="C++ CLI" Value="public:
 bool NameEquals(ReadOnlySpan<char> text);" />
<MemberType>Method</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.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.ReadOnlySpan<System.Char>" />
</Parameters>
<Docs>
<param name="text">The text to compare against.</param>
<summary>Compares the specified text as a character span to the name of this property.</summary>
<returns>
<see langword="true" /> if the name of this property matches <paramref name="text" />; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method is functionally equal to doing an ordinal comparison of `text` and <xref:System.Text.Json.JsonProperty.Name>, but it can avoid creating the string instance.
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">This value's <see cref="T:System.Type" /> is not <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />.</exception>
</Docs>
</Member>
<Member MemberName="NameEquals">
<MemberSignature Language="C#" Value="public bool NameEquals (string? text);" FrameworkAlternate="net-10.0;net-10.0-pp;net-5.0;net-6.0;net-7.0;net-8.0;net-8.0-pp;net-9.0;net-9.0-pp;netframework-4.6.2-pp;netstandard-2.0-pp" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool NameEquals(string text) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.JsonProperty.NameEquals(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function NameEquals (text As String) As Boolean" />
<MemberSignature Language="F#" Value="member this.NameEquals : string -> bool" Usage="jsonProperty.NameEquals text" />
<MemberSignature Language="C++ CLI" Value="public:
 bool NameEquals(System::String ^ text);" />
<MemberSignature Language="C#" Value="public bool NameEquals (string text);" FrameworkAlternate="netcore-3.0;netcore-3.1" />
<MemberType>Method</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.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<param name="text">The text to compare against.</param>
<summary>Compares the specified string to the name of this property.</summary>
<returns>
<see langword="true" /> if the name of this property matches <paramref name="text" />; otherwise <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method is functionally equal to doing an ordinal comparison of `text` and <xref:System.Text.Json.JsonProperty.Name>.
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">This value's <see cref="T:System.Type" /> is not <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />.</exception>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.JsonProperty.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="jsonProperty.ToString " />
<MemberSignature Language="C++ CLI" Value="public:
 override System::String ^ ToString();" />
<MemberType>Method</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.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Provides a string representation of the property for debugging purposes.</summary>
<returns>A string containing the uninterpreted value of the property, beginning at the declaring open-quote and ending at the last character that is part of the value.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Value">
<MemberSignature Language="C#" Value="public System.Text.Json.JsonElement Value { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Text.Json.JsonElement Value" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.JsonProperty.Value" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Value As JsonElement" />
<MemberSignature Language="F#" Value="member this.Value : System.Text.Json.JsonElement" Usage="System.Text.Json.JsonProperty.Value" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Text::Json::JsonElement Value { System::Text::Json::JsonElement 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.JsonElement</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the value of this property.</summary>
<value>The value of this property.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WriteTo">
<MemberSignature Language="C#" Value="public void WriteTo (System.Text.Json.Utf8JsonWriter writer);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void WriteTo(class System.Text.Json.Utf8JsonWriter writer) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.JsonProperty.WriteTo(System.Text.Json.Utf8JsonWriter)" />
<MemberSignature Language="VB.NET" Value="Public Sub WriteTo (writer As Utf8JsonWriter)" />
<MemberSignature Language="F#" Value="member this.WriteTo : System.Text.Json.Utf8JsonWriter -> unit" Usage="jsonProperty.WriteTo writer" />
<MemberSignature Language="C++ CLI" Value="public:
 void WriteTo(System::Text::Json::Utf8JsonWriter ^ writer);" />
<MemberType>Method</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.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Text.Json.Utf8JsonWriter" />
</Parameters>
<Docs>
<param name="writer">The writer to which to write the property.</param>
<summary>Writes the property to the provided writer as a named JSON object property.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="writer" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<see cref="P:System.Text.Json.JsonProperty.Name" /> is too large to be a JSON object property.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Text.Json.JsonElement.ValueKind" /> of this JSON property's <see cref="P:System.Text.Json.JsonProperty.Value" /> would result in invalid JSON.</exception>
<exception cref="T:System.ObjectDisposedException">The parent <see cref="T:System.Text.Json.JsonDocument" /> has been disposed.</exception>
</Docs>
</Member>
</Members>
</Type>