-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Copy pathUtf8JsonWriter.xml
5410 lines (4972 loc) · 321 KB
/
Utf8JsonWriter.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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<Type Name="Utf8JsonWriter" FullName="System.Text.Json.Utf8JsonWriter">
<TypeSignature Language="C#" Value="public sealed class Utf8JsonWriter : IAsyncDisposable, IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit Utf8JsonWriter extends System.Object implements class System.IAsyncDisposable, class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:System.Text.Json.Utf8JsonWriter" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class Utf8JsonWriter
Implements IAsyncDisposable, IDisposable" />
<TypeSignature Language="F#" Value="type Utf8JsonWriter = class
 interface IAsyncDisposable
 interface IDisposable" FrameworkAlternate="net-10.0;net-5.0;net-6.0;net-7.0;net-8.0;net-9.0;netcore-3.0;netcore-3.1" />
<TypeSignature Language="C++ CLI" Value="public ref class Utf8JsonWriter sealed : IAsyncDisposable, IDisposable" />
<TypeSignature Language="F#" Value="type Utf8JsonWriter = class
 interface IDisposable
 interface IAsyncDisposable" FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp;netframework-4.6.2-pp;netstandard-2.0-pp" />
<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.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IAsyncDisposable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<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>Provides a high-performance API for forward-only, non-cached writing of UTF-8 encoded JSON text.</summary>
<remarks>
<format type="text/markdown"><, with the exception of writing comments.
A method that attempts to write invalid JSON when validation is enabled throws an <xref:System.InvalidOperationException> with a context-specific error message.
To be able to format the output with indentation and white space, to skip validation, OR to customize the escaping behavior, create an instance of <xref:System.Text.Json.JsonWriterOptions> and pass it in to the writer.
For more information, see [How to write custom serializers and deserializers with System.Text.Json](/dotnet/standard/serialization/write-custom-serializer-deserializer#use-utf8jsonwriter).
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Utf8JsonWriter (System.Buffers.IBufferWriter<byte> bufferWriter, System.Text.Json.JsonWriterOptions options = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Buffers.IBufferWriter`1<unsigned int8> bufferWriter, valuetype System.Text.Json.JsonWriterOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonWriter.#ctor(System.Buffers.IBufferWriter{System.Byte},System.Text.Json.JsonWriterOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (bufferWriter As IBufferWriter(Of Byte), Optional options As JsonWriterOptions = Nothing)" />
<MemberSignature Language="F#" Value="new System.Text.Json.Utf8JsonWriter : System.Buffers.IBufferWriter<byte> * System.Text.Json.JsonWriterOptions -> System.Text.Json.Utf8JsonWriter" Usage="new System.Text.Json.Utf8JsonWriter (bufferWriter, 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="bufferWriter" Type="System.Buffers.IBufferWriter<System.Byte>" />
<Parameter Name="options" Type="System.Text.Json.JsonWriterOptions" />
</Parameters>
<Docs>
<param name="bufferWriter">The destination for writing JSON text.</param>
<param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" />. By default, it writes minimized JSON (with no extra white space) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>
<summary>Initializes a new instance of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> class using the specified <see cref="T:System.Buffers.IBufferWriter`1" /> to write the output to and customization options.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="bufferWriter" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Utf8JsonWriter (System.IO.Stream utf8Json, System.Text.Json.JsonWriterOptions options = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Stream utf8Json, valuetype System.Text.Json.JsonWriterOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonWriter.#ctor(System.IO.Stream,System.Text.Json.JsonWriterOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (utf8Json As Stream, Optional options As JsonWriterOptions = Nothing)" />
<MemberSignature Language="F#" Value="new System.Text.Json.Utf8JsonWriter : System.IO.Stream * System.Text.Json.JsonWriterOptions -> System.Text.Json.Utf8JsonWriter" Usage="new System.Text.Json.Utf8JsonWriter (utf8Json, 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="utf8Json" Type="System.IO.Stream" />
<Parameter Name="options" Type="System.Text.Json.JsonWriterOptions" />
</Parameters>
<Docs>
<param name="utf8Json">The destination for writing JSON text.</param>
<param name="options">Defines the customized behavior of the <see cref="T:System.Text.Json.Utf8JsonWriter" />. By default, it writes minimized JSON (with no extra white space) and validates that the JSON being written is structurally valid according to the JSON RFC.</param>
<summary>Initializes a new instance of the <see cref="T:System.Text.Json.Utf8JsonWriter" /> class using the specified stream to write the output to and customization options.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="utf8Json" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="BytesCommitted">
<MemberSignature Language="C#" Value="public long BytesCommitted { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 BytesCommitted" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.Utf8JsonWriter.BytesCommitted" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property BytesCommitted As Long" />
<MemberSignature Language="F#" Value="member this.BytesCommitted : int64" Usage="System.Text.Json.Utf8JsonWriter.BytesCommitted" />
<MemberSignature Language="C++ CLI" Value="public:
 property long BytesCommitted { long 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.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the total number of bytes committed to the output by the current instance so far.</summary>
<value>The total number of bytes committed to the output by the <see cref="T:System.Text.Json.Utf8JsonWriter" /> so far.</value>
<remarks>
<format><![CDATA[
## Remarks
In the case of an <xref:System.Buffers.IBufferWriter%601>, this property indicates how much the IBufferWriter has advanced.
In the case of a <xref:System.IO.Stream>, this property indicates how much data has been written to the stream.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="BytesPending">
<MemberSignature Language="C#" Value="public int BytesPending { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 BytesPending" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.Utf8JsonWriter.BytesPending" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property BytesPending As Integer" />
<MemberSignature Language="F#" Value="member this.BytesPending : int" Usage="System.Text.Json.Utf8JsonWriter.BytesPending" />
<MemberSignature Language="C++ CLI" Value="public:
 property int BytesPending { int 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.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the number of bytes written by the <see cref="T:System.Text.Json.Utf8JsonWriter" /> so far that have not yet been flushed to the output and committed.</summary>
<value>The number of bytes written so far by the <see cref="T:System.Text.Json.Utf8JsonWriter" /> that have not yet been flushed to the output and committed.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CurrentDepth">
<MemberSignature Language="C#" Value="public int CurrentDepth { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 CurrentDepth" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.Utf8JsonWriter.CurrentDepth" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CurrentDepth As Integer" />
<MemberSignature Language="F#" Value="member this.CurrentDepth : int" Usage="System.Text.Json.Utf8JsonWriter.CurrentDepth" />
<MemberSignature Language="C++ CLI" Value="public:
 property int CurrentDepth { int 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.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the depth of the current token.</summary>
<value>The depth of the current token.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The `CurrentDepth` property tracks the recursive depth of the nested objects / arrays within the JSON text written so far.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonWriter.Dispose" />
<MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="utf8JsonWriter.Dispose " />
<MemberSignature Language="C++ CLI" Value="public:
 virtual void Dispose();" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
</Implements>
<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 />
<Docs>
<summary>Commits any leftover JSON text that has not yet been flushed and releases all resources used by the current instance.</summary>
<remarks>
<format><![CDATA[
## Remarks
In the case of IBufferWriter, this advances the underlying <xref:System.Buffers.IBufferWriter`1> based on what has been written so far.
In the case of Stream, this writes the data to the stream and flushes it.
The <xref:System.Text.Json.Utf8JsonWriter> instance cannot be reused after disposing.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="DisposeAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.ValueTask DisposeAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.Threading.Tasks.ValueTask DisposeAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonWriter.DisposeAsync" />
<MemberSignature Language="VB.NET" Value="Public Function DisposeAsync () As ValueTask" />
<MemberSignature Language="F#" Value="abstract member DisposeAsync : unit -> System.Threading.Tasks.ValueTask
override this.DisposeAsync : unit -> System.Threading.Tasks.ValueTask" Usage="utf8JsonWriter.DisposeAsync " />
<MemberSignature Language="C++ CLI" Value="public:
 virtual System::Threading::Tasks::ValueTask DisposeAsync();" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IAsyncDisposable.DisposeAsync</InterfaceMember>
</Implements>
<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.Threading.Tasks.ValueTask</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Asynchronously commits any leftover JSON text that has not yet been flushed and releases all resources used by the current instance.</summary>
<returns>A task representing the asynchronous dispose operation.</returns>
<remarks>
<format><![CDATA[
## Remarks
In the case of IBufferWriter, this advances the underlying <xref:System.Buffers.IBufferWriter`1> based on what has been written so far.
In the case of Stream, this writes the data to the stream and flushes it.
The <xref:System.Text.Json.Utf8JsonWriter> instance cannot be reused after disposing.
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <xref:System.ArgumentException>, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <xref:System.Text.Json.Utf8JsonWriter.Dispose>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Flush">
<MemberSignature Language="C#" Value="public void Flush ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Flush() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonWriter.Flush" />
<MemberSignature Language="VB.NET" Value="Public Sub Flush ()" />
<MemberSignature Language="F#" Value="member this.Flush : unit -> unit" Usage="utf8JsonWriter.Flush " />
<MemberSignature Language="C++ CLI" Value="public:
 void Flush();" />
<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 />
<Docs>
<summary>Commits the JSON text written so far, which makes it visible to the output destination.</summary>
<remarks>
<format><![CDATA[
## Remarks
In the case of IBufferWriter, this advances the underlying <xref:System.Buffers.IBufferWriter`1> based on what has been written so far.
In the case of <xref:System.IO.Stream>, this writes the data to the stream and flushes it.
]]></format>
</remarks>
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
</Docs>
</Member>
<Member MemberName="FlushAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task FlushAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task FlushAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonWriter.FlushAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function FlushAsync (Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="member this.FlushAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="utf8JsonWriter.FlushAsync cancellationToken" />
<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.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<summary>Asynchronously commits the JSON text written so far, which makes it visible to the output destination.</summary>
<returns>A task representing the asynchronous flush operation.</returns>
<remarks>
<format><![CDATA[
## Remarks
In the case of IBufferWriter, this advances the underlying <xref:System.Buffers.IBufferWriter`1> based on what has been written so far.
In the case of <xref:System.IO.Stream>, this writes the data to the stream and flushes it asynchronously, while monitoring cancellation requests.
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <xref:System.ArgumentException>, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <xref:System.Text.Json.Utf8JsonWriter.Flush>.
]]></format>
</remarks>
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
</Docs>
</Member>
<Member MemberName="Options">
<MemberSignature Language="C#" Value="public System.Text.Json.JsonWriterOptions Options { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Text.Json.JsonWriterOptions Options" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.Utf8JsonWriter.Options" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Options As JsonWriterOptions" />
<MemberSignature Language="F#" Value="member this.Options : System.Text.Json.JsonWriterOptions" Usage="System.Text.Json.Utf8JsonWriter.Options" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Text::Json::JsonWriterOptions Options { System::Text::Json::JsonWriterOptions 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.JsonWriterOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the custom behavior when writing JSON using this instance, which indicates whether to format the output while writing, whether to skip structural JSON validation, and which characters to escape.</summary>
<value>The custom behavior of this instance of the writer for formatting, validating, and escaping.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Reset">
<MemberSignature Language="C#" Value="public void Reset ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Reset() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonWriter.Reset" />
<MemberSignature Language="VB.NET" Value="Public Sub Reset ()" />
<MemberSignature Language="F#" Value="member this.Reset : unit -> unit" Usage="utf8JsonWriter.Reset " />
<MemberSignature Language="C++ CLI" Value="public:
 void Reset();" />
<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 />
<Docs>
<summary>Resets the internal state of this instance so that it can be reused.</summary>
<remarks>
<format><![CDATA[
## Remarks
The <xref:System.Text.Json.Utf8JsonWriter> will continue to use the original writer options and the original output (either <xref:System.Buffers.IBufferWriter`1> or <xref:System.IO.Stream>) as the destination.
]]></format>
</remarks>
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
</Docs>
</Member>
<Member MemberName="Reset">
<MemberSignature Language="C#" Value="public void Reset (System.Buffers.IBufferWriter<byte> bufferWriter);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Reset(class System.Buffers.IBufferWriter`1<unsigned int8> bufferWriter) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonWriter.Reset(System.Buffers.IBufferWriter{System.Byte})" />
<MemberSignature Language="VB.NET" Value="Public Sub Reset (bufferWriter As IBufferWriter(Of Byte))" />
<MemberSignature Language="F#" Value="member this.Reset : System.Buffers.IBufferWriter<byte> -> unit" Usage="utf8JsonWriter.Reset bufferWriter" />
<MemberSignature Language="C++ CLI" Value="public:
 void Reset(System::Buffers::IBufferWriter<System::Byte> ^ bufferWriter);" />
<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="bufferWriter" Type="System.Buffers.IBufferWriter<System.Byte>" />
</Parameters>
<Docs>
<param name="bufferWriter">The destination for writing JSON text.</param>
<summary>Resets the internal state of this instance so that it can be reused with a new instance of <see cref="T:System.Buffers.IBufferWriter`1" />.</summary>
<remarks>
<format><![CDATA[
## Remarks
The <xref:System.Text.Json.Utf8JsonWriter> will continue to use the original writer options but now writes to `bufferWriter` as the new destination.
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="bufferWriter" /> is <see langword="null" />.</exception>
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
</Docs>
</Member>
<Member MemberName="Reset">
<MemberSignature Language="C#" Value="public void Reset (System.IO.Stream utf8Json);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Reset(class System.IO.Stream utf8Json) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonWriter.Reset(System.IO.Stream)" />
<MemberSignature Language="VB.NET" Value="Public Sub Reset (utf8Json As Stream)" />
<MemberSignature Language="F#" Value="member this.Reset : System.IO.Stream -> unit" Usage="utf8JsonWriter.Reset utf8Json" />
<MemberSignature Language="C++ CLI" Value="public:
 void Reset(System::IO::Stream ^ utf8Json);" />
<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="utf8Json" Type="System.IO.Stream" />
</Parameters>
<Docs>
<param name="utf8Json">The destination for writing JSON text.</param>
<summary>Resets the internal state of this instance so that it can be reused with a new instance of <see cref="T:System.IO.Stream" />.</summary>
<remarks>
<format><![CDATA[
## Remarks
The <xref:System.Text.Json.Utf8JsonWriter> will continue to use the original writer options but now writes to `utf8Json` as the new destination.
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="utf8Json" /> is <see langword="null" />.</exception>
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
</Docs>
</Member>
<Member MemberName="WriteBase64String">
<MemberSignature Language="C#" Value="public void WriteBase64String (ReadOnlySpan<byte> utf8PropertyName, ReadOnlySpan<byte> bytes);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void WriteBase64String(valuetype System.ReadOnlySpan`1<unsigned int8> utf8PropertyName, valuetype System.ReadOnlySpan`1<unsigned int8> bytes) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonWriter.WriteBase64String(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte})" />
<MemberSignature Language="VB.NET" Value="Public Sub WriteBase64String (utf8PropertyName As ReadOnlySpan(Of Byte), bytes As ReadOnlySpan(Of Byte))" />
<MemberSignature Language="F#" Value="member this.WriteBase64String : ReadOnlySpan<byte> * ReadOnlySpan<byte> -> unit" Usage="utf8JsonWriter.WriteBase64String (utf8PropertyName, bytes)" />
<MemberSignature Language="C++ CLI" Value="public:
 void WriteBase64String(ReadOnlySpan<System::Byte> utf8PropertyName, ReadOnlySpan<System::Byte> bytes);" />
<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="utf8PropertyName" Type="System.ReadOnlySpan<System.Byte>" />
<Parameter Name="bytes" Type="System.ReadOnlySpan<System.Byte>" />
</Parameters>
<Docs>
<param name="utf8PropertyName">The UTF-8 encoded name of the property to write.</param>
<param name="bytes">The binary data to write as Base64 encoded text.</param>
<summary>Writes the property name and raw bytes value (as a Base64 encoded JSON string) as part of a name/value pair of a JSON object.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The maximum allowed size of the binary data to write as Base64 is 125,000,000 bytes (or approximately 125 MB). Exceeding this limit results in an <xref:System.ArgumentException> being thrown.
The property name is escaped and the bytes are encoded before writing.
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
<exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
</Docs>
</Member>
<Member MemberName="WriteBase64String">
<MemberSignature Language="C#" Value="public void WriteBase64String (ReadOnlySpan<char> propertyName, ReadOnlySpan<byte> bytes);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void WriteBase64String(valuetype System.ReadOnlySpan`1<char> propertyName, valuetype System.ReadOnlySpan`1<unsigned int8> bytes) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonWriter.WriteBase64String(System.ReadOnlySpan{System.Char},System.ReadOnlySpan{System.Byte})" />
<MemberSignature Language="VB.NET" Value="Public Sub WriteBase64String (propertyName As ReadOnlySpan(Of Char), bytes As ReadOnlySpan(Of Byte))" />
<MemberSignature Language="F#" Value="member this.WriteBase64String : ReadOnlySpan<char> * ReadOnlySpan<byte> -> unit" Usage="utf8JsonWriter.WriteBase64String (propertyName, bytes)" />
<MemberSignature Language="C++ CLI" Value="public:
 void WriteBase64String(ReadOnlySpan<char> propertyName, ReadOnlySpan<System::Byte> bytes);" />
<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="propertyName" Type="System.ReadOnlySpan<System.Char>" />
<Parameter Name="bytes" Type="System.ReadOnlySpan<System.Byte>" />
</Parameters>
<Docs>
<param name="propertyName">The property name of the JSON object to be transcoded and written as UTF-8.</param>
<param name="bytes">The binary data to write as Base64 encoded text.</param>
<summary>Writes the property name and raw bytes value (as a Base64 encoded JSON string) as part of a name/value pair of a JSON object.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The maximum allowed size of the binary data to write as Base64 is 125,000,000 bytes (or approximately 125 MB). Exceeding this limit results in an <xref:System.ArgumentException> being thrown.
The property name is escaped and the bytes are encoded before writing.
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
<exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
</Docs>
</Member>
<Member MemberName="WriteBase64String">
<MemberSignature Language="C#" Value="public void WriteBase64String (string propertyName, ReadOnlySpan<byte> bytes);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void WriteBase64String(string propertyName, valuetype System.ReadOnlySpan`1<unsigned int8> bytes) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonWriter.WriteBase64String(System.String,System.ReadOnlySpan{System.Byte})" />
<MemberSignature Language="VB.NET" Value="Public Sub WriteBase64String (propertyName As String, bytes As ReadOnlySpan(Of Byte))" />
<MemberSignature Language="F#" Value="member this.WriteBase64String : string * ReadOnlySpan<byte> -> unit" Usage="utf8JsonWriter.WriteBase64String (propertyName, bytes)" />
<MemberSignature Language="C++ CLI" Value="public:
 void WriteBase64String(System::String ^ propertyName, ReadOnlySpan<System::Byte> bytes);" />
<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="propertyName" Type="System.String">
<Attributes>
<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(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(1)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<Parameter Name="bytes" Type="System.ReadOnlySpan<System.Byte>" />
</Parameters>
<Docs>
<param name="propertyName">The property name of the JSON object to be transcoded and written as UTF-8.</param>
<param name="bytes">The binary data to write as Base64 encoded text.</param>
<summary>Writes the property name and raw bytes value (as a Base64 encoded JSON string) as part of a name/value pair of a JSON object.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The maximum allowed size of the binary data to write as Base64 is 125,000,000 bytes (or approximately 125 MB). Exceeding this limit results in an <xref:System.ArgumentException> being thrown.
The property name is escaped and the bytes are encoded before writing.
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">The specified property name or value is too large.</exception>
<exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="WriteBase64String">
<MemberSignature Language="C#" Value="public void WriteBase64String (System.Text.Json.JsonEncodedText propertyName, ReadOnlySpan<byte> bytes);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void WriteBase64String(valuetype System.Text.Json.JsonEncodedText propertyName, valuetype System.ReadOnlySpan`1<unsigned int8> bytes) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonWriter.WriteBase64String(System.Text.Json.JsonEncodedText,System.ReadOnlySpan{System.Byte})" />
<MemberSignature Language="VB.NET" Value="Public Sub WriteBase64String (propertyName As JsonEncodedText, bytes As ReadOnlySpan(Of Byte))" />
<MemberSignature Language="F#" Value="member this.WriteBase64String : System.Text.Json.JsonEncodedText * ReadOnlySpan<byte> -> unit" Usage="utf8JsonWriter.WriteBase64String (propertyName, bytes)" />
<MemberSignature Language="C++ CLI" Value="public:
 void WriteBase64String(System::Text::Json::JsonEncodedText propertyName, ReadOnlySpan<System::Byte> bytes);" />
<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="propertyName" Type="System.Text.Json.JsonEncodedText" />
<Parameter Name="bytes" Type="System.ReadOnlySpan<System.Byte>" />
</Parameters>
<Docs>
<param name="propertyName">The JSON-encoded name of the property to write.</param>
<param name="bytes">The binary data to write as Base64 encoded text.</param>
<summary>Writes the pre-encoded property name and raw bytes value (as a Base64 encoded JSON string) as part of a name/value pair of a JSON object.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The maximum allowed size of the binary data to write as Base64 is 125,000,000 bytes (or approximately 125 MB). Exceeding this limit results in an <xref:System.ArgumentException> being thrown.
The property name should already be escaped when the instance of <xref:System.Text.Json.JsonEncodedText> was created.
The bytes are encoded before writing.
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">The specified value is too large.</exception>
<exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
</Docs>
</Member>
<Member MemberName="WriteBase64StringSegment">
<MemberSignature Language="C#" Value="public void WriteBase64StringSegment (ReadOnlySpan<byte> value, bool isFinalSegment);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void WriteBase64StringSegment(valuetype System.ReadOnlySpan`1<unsigned int8> value, bool isFinalSegment) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonWriter.WriteBase64StringSegment(System.ReadOnlySpan{System.Byte},System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub WriteBase64StringSegment (value As ReadOnlySpan(Of Byte), isFinalSegment As Boolean)" />
<MemberSignature Language="F#" Value="member this.WriteBase64StringSegment : ReadOnlySpan<byte> * bool -> unit" Usage="utf8JsonWriter.WriteBase64StringSegment (value, isFinalSegment)" />
<MemberSignature Language="C++ CLI" Value="public:
 void WriteBase64StringSegment(ReadOnlySpan<System::Byte> value, bool isFinalSegment);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.ReadOnlySpan<System.Byte>" Index="0" FrameworkAlternate="net-10.0;net-10.0-pp;net-8.0-pp;net-9.0-pp;netframework-4.6.2-pp;netstandard-2.0-pp" />
<Parameter Name="isFinalSegment" Type="System.Boolean" Index="1" FrameworkAlternate="net-10.0;net-10.0-pp;net-8.0-pp;net-9.0-pp;netframework-4.6.2-pp;netstandard-2.0-pp" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<param name="isFinalSegment">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WriteBase64StringValue">
<MemberSignature Language="C#" Value="public void WriteBase64StringValue (ReadOnlySpan<byte> bytes);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void WriteBase64StringValue(valuetype System.ReadOnlySpan`1<unsigned int8> bytes) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonWriter.WriteBase64StringValue(System.ReadOnlySpan{System.Byte})" />
<MemberSignature Language="VB.NET" Value="Public Sub WriteBase64StringValue (bytes As ReadOnlySpan(Of Byte))" />
<MemberSignature Language="F#" Value="member this.WriteBase64StringValue : ReadOnlySpan<byte> -> unit" Usage="utf8JsonWriter.WriteBase64StringValue bytes" />
<MemberSignature Language="C++ CLI" Value="public:
 void WriteBase64StringValue(ReadOnlySpan<System::Byte> bytes);" />
<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="bytes" Type="System.ReadOnlySpan<System.Byte>" />
</Parameters>
<Docs>
<param name="bytes">The binary data to be written as a Base64 encoded JSON string element of a JSON array.</param>
<summary>Writes the raw bytes value as a Base64 encoded JSON string as an element of a JSON array.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The maximum allowed size of the binary data to write as Base64 is 125,000,000 bytes (or approximately 125 MB). Exceeding this limit results in an <xref:System.ArgumentException> being thrown.
The bytes are encoded before writing.
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">The specified value is too large.</exception>
<exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
</Docs>
</Member>
<Member MemberName="WriteBoolean">
<MemberSignature Language="C#" Value="public void WriteBoolean (ReadOnlySpan<byte> utf8PropertyName, bool value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void WriteBoolean(valuetype System.ReadOnlySpan`1<unsigned int8> utf8PropertyName, bool value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonWriter.WriteBoolean(System.ReadOnlySpan{System.Byte},System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub WriteBoolean (utf8PropertyName As ReadOnlySpan(Of Byte), value As Boolean)" />
<MemberSignature Language="F#" Value="member this.WriteBoolean : ReadOnlySpan<byte> * bool -> unit" Usage="utf8JsonWriter.WriteBoolean (utf8PropertyName, value)" />
<MemberSignature Language="C++ CLI" Value="public:
 void WriteBoolean(ReadOnlySpan<System::Byte> utf8PropertyName, bool value);" />
<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="utf8PropertyName" Type="System.ReadOnlySpan<System.Byte>" />
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="utf8PropertyName">The UTF-8 encoded property name of the JSON object to be written.</param>
<param name="value">The value to be written as a JSON literal <b>true</b> or <b>false</b> as part of the name/value pair.</param>
<summary>Writes a property name specified as a read-only span of bytes and a <see cref="T:System.Boolean" /> value (as a JSON literal <b>true</b> or <b>false</b>) as part of a name/value pair of a JSON object.</summary>
<remarks>
<format><![CDATA[
## Remarks
The property name is escaped before writing.
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
<exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
</Docs>
</Member>
<Member MemberName="WriteBoolean">
<MemberSignature Language="C#" Value="public void WriteBoolean (ReadOnlySpan<char> propertyName, bool value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void WriteBoolean(valuetype System.ReadOnlySpan`1<char> propertyName, bool value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonWriter.WriteBoolean(System.ReadOnlySpan{System.Char},System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub WriteBoolean (propertyName As ReadOnlySpan(Of Char), value As Boolean)" />
<MemberSignature Language="F#" Value="member this.WriteBoolean : ReadOnlySpan<char> * bool -> unit" Usage="utf8JsonWriter.WriteBoolean (propertyName, value)" />
<MemberSignature Language="C++ CLI" Value="public:
 void WriteBoolean(ReadOnlySpan<char> propertyName, bool value);" />
<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="propertyName" Type="System.ReadOnlySpan<System.Char>" />
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
<param name="value">The value to be written as a JSON literal <b>true</b> or <b>false</b> as part of the name/value pair.</param>
<summary>Writes a property name specified as a read-only character span and a <see cref="T:System.Boolean" /> value (as a JSON literal <b>true</b> or <b>false</b>) as part of a name/value pair of a JSON object.</summary>
<remarks>
<format><![CDATA[
## Remarks
The property name is escaped before writing.
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
<exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
</Docs>
</Member>
<Member MemberName="WriteBoolean">
<MemberSignature Language="C#" Value="public void WriteBoolean (string propertyName, bool value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void WriteBoolean(string propertyName, bool value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonWriter.WriteBoolean(System.String,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub WriteBoolean (propertyName As String, value As Boolean)" />
<MemberSignature Language="F#" Value="member this.WriteBoolean : string * bool -> unit" Usage="utf8JsonWriter.WriteBoolean (propertyName, value)" />
<MemberSignature Language="C++ CLI" Value="public:
 void WriteBoolean(System::String ^ propertyName, bool value);" />
<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="propertyName" Type="System.String" />
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="propertyName">The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
<param name="value">The value to be written as a JSON literal <b>true</b> or <b>false</b> as part of the name/value pair.</param>
<summary>Writes a property name specified as a string and a <see cref="T:System.Boolean" /> value (as a JSON literal <b>true</b> or <b>false</b>) as part of a name/value pair of a JSON object.</summary>
<remarks>
<format><![CDATA[
## Remarks
The property name is escaped before writing.
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">The specified property name is too large.</exception>
<exception cref="T:System.InvalidOperationException">Validation is enabled, and the operation would result in writing invalid JSON.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="propertyName" /> parameter is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="WriteBoolean">
<MemberSignature Language="C#" Value="public void WriteBoolean (System.Text.Json.JsonEncodedText propertyName, bool value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void WriteBoolean(valuetype System.Text.Json.JsonEncodedText propertyName, bool value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonWriter.WriteBoolean(System.Text.Json.JsonEncodedText,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub WriteBoolean (propertyName As JsonEncodedText, value As Boolean)" />
<MemberSignature Language="F#" Value="member this.WriteBoolean : System.Text.Json.JsonEncodedText * bool -> unit" Usage="utf8JsonWriter.WriteBoolean (propertyName, value)" />
<MemberSignature Language="C++ CLI" Value="public:
 void WriteBoolean(System::Text::Json::JsonEncodedText propertyName, bool value);" />
<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="propertyName" Type="System.Text.Json.JsonEncodedText" />
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="propertyName">The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.</param>
<param name="value">The value to be written as a JSON literal <b>true</b> or <b>false</b> as part of the name/value pair.</param>
<summary>Writes the pre-encoded property name and <see cref="T:System.Boolean" /> value (as a JSON literal <b>true</b> or <b>false</b>) as part of a name/value pair of a JSON object.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The property name should already be escaped when the instance of <xref:System.Text.Json.JsonEncodedText> was created.
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">Validation is enabled, and this method would result in writing invalid JSON.</exception>
</Docs>
</Member>
<Member MemberName="WriteBooleanValue">
<MemberSignature Language="C#" Value="public void WriteBooleanValue (bool value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void WriteBooleanValue(bool value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Utf8JsonWriter.WriteBooleanValue(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub WriteBooleanValue (value As Boolean)" />
<MemberSignature Language="F#" Value="member this.WriteBooleanValue : bool -> unit" Usage="utf8JsonWriter.WriteBooleanValue value" />
<MemberSignature Language="C++ CLI" Value="public:
 void WriteBooleanValue(bool value);" />
<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="value" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="value">The value to be written as a JSON literal <b>true</b> or <b>false</b> as an element of a JSON array.</param>
<summary>Writes a <see cref="T:System.Boolean" /> value (as a JSON literal <b>true</b> or <b>false</b>) as an element of a JSON array.</summary>