/
JsonObjectSerializer.xml
338 lines (338 loc) · 22.7 KB
/
JsonObjectSerializer.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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
<Type Name="JsonObjectSerializer" FullName="Azure.Core.Serialization.JsonObjectSerializer">
<TypeSignature Language="C#" Value="public class JsonObjectSerializer : Azure.Core.Serialization.ObjectSerializer, Azure.Core.Serialization.IMemberNameConverter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit JsonObjectSerializer extends Azure.Core.Serialization.ObjectSerializer implements class Azure.Core.Serialization.IMemberNameConverter" />
<TypeSignature Language="DocId" Value="T:Azure.Core.Serialization.JsonObjectSerializer" />
<TypeSignature Language="VB.NET" Value="Public Class JsonObjectSerializer
Inherits ObjectSerializer
Implements IMemberNameConverter" />
<TypeSignature Language="F#" Value="type JsonObjectSerializer = class
 inherit ObjectSerializer
 interface IMemberNameConverter" />
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.15.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
<AssemblyVersion>1.18.0.0</AssemblyVersion>
<AssemblyVersion>1.19.0.0</AssemblyVersion>
<AssemblyVersion>1.20.0.0</AssemblyVersion>
<AssemblyVersion>1.21.0.0</AssemblyVersion>
<AssemblyVersion>1.22.0.0</AssemblyVersion>
<AssemblyVersion>1.23.0.0</AssemblyVersion>
<AssemblyVersion>1.24.0.0</AssemblyVersion>
<AssemblyVersion>1.25.0.0</AssemblyVersion>
<AssemblyVersion>1.26.0.0</AssemblyVersion>
<AssemblyVersion>1.27.0.0</AssemblyVersion>
<AssemblyVersion>1.28.0.0</AssemblyVersion>
<AssemblyVersion>1.29.0.0</AssemblyVersion>
<AssemblyVersion>1.30.0.0</AssemblyVersion>
<AssemblyVersion>1.31.0.0</AssemblyVersion>
<AssemblyVersion>1.32.0.0</AssemblyVersion>
<AssemblyVersion>1.33.0.0</AssemblyVersion>
<AssemblyVersion>1.34.0.0</AssemblyVersion>
<AssemblyVersion>1.35.0.0</AssemblyVersion>
<AssemblyVersion>1.36.0.0</AssemblyVersion>
<AssemblyVersion>1.37.0.0</AssemblyVersion>
<AssemblyVersion>1.38.0.0</AssemblyVersion>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.Core.Serialization.ObjectSerializer</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Azure.Core.Serialization.IMemberNameConverter</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
An <see cref="T:Azure.Core.Serialization.ObjectSerializer" /> implementation that uses <see cref="T:System.Text.Json.JsonSerializer" /> for serialization/deserialization.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public JsonObjectSerializer ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Serialization.JsonObjectSerializer.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes new instance of <see cref="T:Azure.Core.Serialization.JsonObjectSerializer" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public JsonObjectSerializer (System.Text.Json.JsonSerializerOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Text.Json.JsonSerializerOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Serialization.JsonObjectSerializer.#ctor(System.Text.Json.JsonSerializerOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (options As JsonSerializerOptions)" />
<MemberSignature Language="F#" Value="new Azure.Core.Serialization.JsonObjectSerializer : System.Text.Json.JsonSerializerOptions -> Azure.Core.Serialization.JsonObjectSerializer" Usage="new Azure.Core.Serialization.JsonObjectSerializer options" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="options" Type="System.Text.Json.JsonSerializerOptions" />
</Parameters>
<Docs>
<param name="options">The <see cref="T:System.Text.Json.JsonSerializerOptions" /> instance to use when serializing/deserializing.</param>
<summary>
Initializes new instance of <see cref="T:Azure.Core.Serialization.JsonObjectSerializer" />.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="options" /> is null.</exception>
</Docs>
</Member>
<Member MemberName="Azure.Core.Serialization.IMemberNameConverter.ConvertMemberName">
<MemberSignature Language="C#" Value="string? IMemberNameConverter.ConvertMemberName (System.Reflection.MemberInfo member);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance string Azure.Core.Serialization.IMemberNameConverter.ConvertMemberName(class System.Reflection.MemberInfo member) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Serialization.JsonObjectSerializer.Azure#Core#Serialization#IMemberNameConverter#ConvertMemberName(System.Reflection.MemberInfo)" />
<MemberSignature Language="VB.NET" Value="Function ConvertMemberName (member As MemberInfo) As String Implements IMemberNameConverter.ConvertMemberName" />
<MemberSignature Language="F#" Value="abstract member Azure.Core.Serialization.IMemberNameConverter.ConvertMemberName : System.Reflection.MemberInfo -> string
override this.Azure.Core.Serialization.IMemberNameConverter.ConvertMemberName : System.Reflection.MemberInfo -> string" Usage="jsonObjectSerializer.Azure.Core.Serialization.IMemberNameConverter.ConvertMemberName member" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Azure.Core.Serialization.IMemberNameConverter.ConvertMemberName(System.Reflection.MemberInfo)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="member" Type="System.Reflection.MemberInfo" />
</Parameters>
<Docs>
<param name="member">The <see cref="T:System.Reflection.MemberInfo" /> to convert to a serializable member name.</param>
<summary>
Converts a <see cref="T:System.Reflection.MemberInfo" /> to a serializable member name.
</summary>
<returns>The serializable member name, or null if the member is not defined or ignored by the serializer.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
<exception cref="T:System.ArgumentNullException">
<paramref name="member" /> is null.</exception>
</Docs>
</Member>
<Member MemberName="Default">
<MemberSignature Language="C#" Value="public static Azure.Core.Serialization.JsonObjectSerializer Default { get; }" />
<MemberSignature Language="ILAsm" Value=".property class Azure.Core.Serialization.JsonObjectSerializer Default" />
<MemberSignature Language="DocId" Value="P:Azure.Core.Serialization.JsonObjectSerializer.Default" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property Default As JsonObjectSerializer" />
<MemberSignature Language="F#" Value="static member Default : Azure.Core.Serialization.JsonObjectSerializer" Usage="Azure.Core.Serialization.JsonObjectSerializer.Default" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Core.Serialization.JsonObjectSerializer</ReturnType>
</ReturnValue>
<Docs>
<summary>
A shared instance of <see cref="T:Azure.Core.Serialization.JsonObjectSerializer" />, initialized with the default options.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Deserialize">
<MemberSignature Language="C#" Value="public override object? Deserialize (System.IO.Stream stream, Type returnType, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance object Deserialize(class System.IO.Stream stream, class System.Type returnType, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Serialization.JsonObjectSerializer.Deserialize(System.IO.Stream,System.Type,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Deserialize (stream As Stream, returnType As Type, cancellationToken As CancellationToken) As Object" />
<MemberSignature Language="F#" Value="override this.Deserialize : System.IO.Stream * Type * System.Threading.CancellationToken -> obj" Usage="jsonObjectSerializer.Deserialize (stream, returnType, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stream" Type="System.IO.Stream" />
<Parameter Name="returnType" Type="System.Type" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="stream">The <see cref="T:System.IO.Stream" /> to read from.</param>
<param name="returnType">The type of the object to convert to and return.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use during deserialization.</param>
<summary>
Read the binary representation into a <paramref name="returnType" />.
The Stream will be read to completion.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="DeserializeAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.ValueTask<object?> DeserializeAsync (System.IO.Stream stream, Type returnType, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance valuetype System.Threading.Tasks.ValueTask`1<object> DeserializeAsync(class System.IO.Stream stream, class System.Type returnType, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Serialization.JsonObjectSerializer.DeserializeAsync(System.IO.Stream,System.Type,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function DeserializeAsync (stream As Stream, returnType As Type, cancellationToken As CancellationToken) As ValueTask(Of Object)" />
<MemberSignature Language="F#" Value="override this.DeserializeAsync : System.IO.Stream * Type * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<obj>" Usage="jsonObjectSerializer.DeserializeAsync (stream, returnType, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.ValueTask<System.Object></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stream" Type="System.IO.Stream" />
<Parameter Name="returnType" Type="System.Type" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="stream">The <see cref="T:System.IO.Stream" /> to read from.</param>
<param name="returnType">The type of the object to convert to and return.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use during deserialization.</param>
<summary>
Read the binary representation into a <paramref name="returnType" />.
The Stream will be read to completion.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Serialize">
<MemberSignature Language="C#" Value="public override BinaryData Serialize (object? value, Type? inputType = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.BinaryData Serialize(object value, class System.Type inputType, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Serialization.JsonObjectSerializer.Serialize(System.Object,System.Type,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Serialize (value As Object, Optional inputType As Type = Nothing, Optional cancellationToken As CancellationToken = Nothing) As BinaryData" />
<MemberSignature Language="F#" Value="override this.Serialize : obj * Type * System.Threading.CancellationToken -> BinaryData" Usage="jsonObjectSerializer.Serialize (value, inputType, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.BinaryData</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Object" />
<Parameter Name="inputType" Type="System.Type" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="value">The value to convert.</param>
<param name="inputType">The type to use when serializing <paramref name="value" />. If omitted, the type will be determined using <see cref="M:System.Object.GetType" />().</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use during serialization.</param>
<summary>
Convert the provided value to it's binary representation and return it as a <see cref="T:System.BinaryData" /> instance.
</summary>
<returns>The object's binary representation as <see cref="T:System.BinaryData" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Serialize">
<MemberSignature Language="C#" Value="public override void Serialize (System.IO.Stream stream, object? value, Type inputType, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Serialize(class System.IO.Stream stream, object value, class System.Type inputType, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Serialization.JsonObjectSerializer.Serialize(System.IO.Stream,System.Object,System.Type,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Serialize (stream As Stream, value As Object, inputType As Type, cancellationToken As CancellationToken)" />
<MemberSignature Language="F#" Value="override this.Serialize : System.IO.Stream * obj * Type * System.Threading.CancellationToken -> unit" Usage="jsonObjectSerializer.Serialize (stream, value, inputType, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stream" Type="System.IO.Stream" />
<Parameter Name="value" Type="System.Object" />
<Parameter Name="inputType" Type="System.Type" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="stream">The <see cref="T:System.IO.Stream" /> to write to.</param>
<param name="value">The value to convert.</param>
<param name="inputType">The type of the <paramref name="value" /> to convert.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use during serialization.</param>
<summary>
Convert the provided value to it's binary representation and write it to <see cref="T:System.IO.Stream" />.
</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="SerializeAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.ValueTask<BinaryData> SerializeAsync (object? value, Type? inputType = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance valuetype System.Threading.Tasks.ValueTask`1<class System.BinaryData> SerializeAsync(object value, class System.Type inputType, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Serialization.JsonObjectSerializer.SerializeAsync(System.Object,System.Type,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function SerializeAsync (value As Object, Optional inputType As Type = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of BinaryData)" />
<MemberSignature Language="F#" Value="override this.SerializeAsync : obj * Type * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<BinaryData>" Usage="jsonObjectSerializer.SerializeAsync (value, inputType, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.ValueTask<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Object" />
<Parameter Name="inputType" Type="System.Type" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="value">The value to convert.</param>
<param name="inputType">The type to use when serializing <paramref name="value" />. If omitted, the type will be determined using <see cref="M:System.Object.GetType" />().</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use during serialization.</param>
<summary>
Convert the provided value to it's binary representation and return it as a <see cref="T:System.BinaryData" /> instance.
</summary>
<returns>The object's binary representation as <see cref="T:System.BinaryData" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SerializeAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.ValueTask SerializeAsync (System.IO.Stream stream, object? value, Type inputType, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance valuetype System.Threading.Tasks.ValueTask SerializeAsync(class System.IO.Stream stream, object value, class System.Type inputType, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.Serialization.JsonObjectSerializer.SerializeAsync(System.IO.Stream,System.Object,System.Type,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function SerializeAsync (stream As Stream, value As Object, inputType As Type, cancellationToken As CancellationToken) As ValueTask" />
<MemberSignature Language="F#" Value="override this.SerializeAsync : System.IO.Stream * obj * Type * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask" Usage="jsonObjectSerializer.SerializeAsync (stream, value, inputType, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.ValueTask</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stream" Type="System.IO.Stream" />
<Parameter Name="value" Type="System.Object" />
<Parameter Name="inputType" Type="System.Type" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="stream">The <see cref="T:System.IO.Stream" /> to write to.</param>
<param name="value">The value to convert.</param>
<param name="inputType">The type of the <paramref name="value" /> to convert.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use during serialization.</param>
<summary>
Convert the provided value to it's binary representation and write it to <see cref="T:System.IO.Stream" />.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
</Type>