-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMicrosoft.IO.RecyclableMemoryStream.xml
More file actions
1523 lines (1523 loc) · 92.2 KB
/
Microsoft.IO.RecyclableMemoryStream.xml
File metadata and controls
1523 lines (1523 loc) · 92.2 KB
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
<?xml version="1.0"?>
<doc>
<assembly>
<name>Microsoft.IO.RecyclableMemoryStream</name>
</assembly>
<members>
<member name="T:Microsoft.IO.RecyclableMemoryStreamManager">
<summary>
Manages pools of <see cref="T:Microsoft.IO.RecyclableMemoryStream"/> objects.
</summary>
<remarks>
<para>
There are two pools managed in here. The small pool contains same-sized buffers that are handed to streams
as they write more data.
</para>
<para>
For scenarios that need to call <see cref="M:Microsoft.IO.RecyclableMemoryStream.GetBuffer"/>, the large pool contains buffers of various sizes, all
multiples/exponentials of <see cref="P:Microsoft.IO.RecyclableMemoryStreamManager.Options.LargeBufferMultiple"/> (1 MB by default). They are split by size to avoid overly-wasteful buffer
usage. There should be far fewer 8 MB buffers than 1 MB buffers, for example.
</para>
</remarks>
</member>
<member name="T:Microsoft.IO.RecyclableMemoryStreamManager.StreamCreatedEventArgs">
<summary>
Arguments for the <see cref="E:Microsoft.IO.RecyclableMemoryStreamManager.StreamCreated"/> event.
</summary>
<remarks>
Initializes a new instance of the <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager.StreamCreatedEventArgs"/> class.
</remarks>
<param name="guid">Unique ID of the stream.</param>
<param name="tag">Tag of the stream.</param>
<param name="requestedSize">The requested stream size.</param>
<param name="actualSize">The actual stream size.</param>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.StreamCreatedEventArgs.#ctor(System.Guid,System.String,System.Int64,System.Int64)">
<summary>
Arguments for the <see cref="E:Microsoft.IO.RecyclableMemoryStreamManager.StreamCreated"/> event.
</summary>
<remarks>
Initializes a new instance of the <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager.StreamCreatedEventArgs"/> class.
</remarks>
<param name="guid">Unique ID of the stream.</param>
<param name="tag">Tag of the stream.</param>
<param name="requestedSize">The requested stream size.</param>
<param name="actualSize">The actual stream size.</param>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamCreatedEventArgs.Id">
<summary>
Unique ID for the stream.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamCreatedEventArgs.Tag">
<summary>
Optional Tag for the event.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamCreatedEventArgs.RequestedSize">
<summary>
Requested stream size.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamCreatedEventArgs.ActualSize">
<summary>
Actual stream size.
</summary>
</member>
<member name="T:Microsoft.IO.RecyclableMemoryStreamManager.StreamDisposedEventArgs">
<summary>
Arguments for the <see cref="E:Microsoft.IO.RecyclableMemoryStreamManager.StreamDisposed"/> event.
</summary>
<remarks>
Initializes a new instance of the <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager.StreamDisposedEventArgs"/> class.
</remarks>
<param name="guid">Unique ID of the stream.</param>
<param name="tag">Tag of the stream.</param>
<param name="lifetime">Lifetime of the stream</param>
<param name="allocationStack">Stack of original allocation.</param>
<param name="disposeStack">Dispose stack.</param>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.StreamDisposedEventArgs.#ctor(System.Guid,System.String,System.TimeSpan,System.String,System.String)">
<summary>
Arguments for the <see cref="E:Microsoft.IO.RecyclableMemoryStreamManager.StreamDisposed"/> event.
</summary>
<remarks>
Initializes a new instance of the <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager.StreamDisposedEventArgs"/> class.
</remarks>
<param name="guid">Unique ID of the stream.</param>
<param name="tag">Tag of the stream.</param>
<param name="lifetime">Lifetime of the stream</param>
<param name="allocationStack">Stack of original allocation.</param>
<param name="disposeStack">Dispose stack.</param>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamDisposedEventArgs.Id">
<summary>
Unique ID for the stream.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamDisposedEventArgs.Tag">
<summary>
Optional Tag for the event.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamDisposedEventArgs.AllocationStack">
<summary>
Stack where the stream was allocated.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamDisposedEventArgs.DisposeStack">
<summary>
Stack where stream was disposed.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamDisposedEventArgs.Lifetime">
<summary>
Lifetime of the stream.
</summary>
</member>
<member name="T:Microsoft.IO.RecyclableMemoryStreamManager.StreamDoubleDisposedEventArgs">
<summary>
Arguments for the <see cref="E:Microsoft.IO.RecyclableMemoryStreamManager.StreamDoubleDisposed"/> event.
</summary>
<remarks>
Initializes a new instance of the <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager.StreamDoubleDisposedEventArgs"/> class.
</remarks>
<param name="guid">Unique ID of the stream.</param>
<param name="tag">Tag of the stream.</param>
<param name="allocationStack">Stack of original allocation.</param>
<param name="disposeStack1">First dispose stack.</param>
<param name="disposeStack2">Second dispose stack.</param>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.StreamDoubleDisposedEventArgs.#ctor(System.Guid,System.String,System.String,System.String,System.String)">
<summary>
Arguments for the <see cref="E:Microsoft.IO.RecyclableMemoryStreamManager.StreamDoubleDisposed"/> event.
</summary>
<remarks>
Initializes a new instance of the <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager.StreamDoubleDisposedEventArgs"/> class.
</remarks>
<param name="guid">Unique ID of the stream.</param>
<param name="tag">Tag of the stream.</param>
<param name="allocationStack">Stack of original allocation.</param>
<param name="disposeStack1">First dispose stack.</param>
<param name="disposeStack2">Second dispose stack.</param>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamDoubleDisposedEventArgs.Id">
<summary>
Unique ID for the stream.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamDoubleDisposedEventArgs.Tag">
<summary>
Optional Tag for the event.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamDoubleDisposedEventArgs.AllocationStack">
<summary>
Stack where the stream was allocated.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamDoubleDisposedEventArgs.DisposeStack1">
<summary>
First dispose stack.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamDoubleDisposedEventArgs.DisposeStack2">
<summary>
Second dispose stack.
</summary>
</member>
<member name="T:Microsoft.IO.RecyclableMemoryStreamManager.StreamFinalizedEventArgs">
<summary>
Arguments for the <see cref="E:Microsoft.IO.RecyclableMemoryStreamManager.StreamFinalized"/> event.
</summary>
<remarks>
Initializes a new instance of the <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager.StreamFinalizedEventArgs"/> class.
</remarks>
<param name="guid">Unique ID of the stream.</param>
<param name="tag">Tag of the stream.</param>
<param name="allocationStack">Stack of original allocation.</param>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.StreamFinalizedEventArgs.#ctor(System.Guid,System.String,System.String)">
<summary>
Arguments for the <see cref="E:Microsoft.IO.RecyclableMemoryStreamManager.StreamFinalized"/> event.
</summary>
<remarks>
Initializes a new instance of the <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager.StreamFinalizedEventArgs"/> class.
</remarks>
<param name="guid">Unique ID of the stream.</param>
<param name="tag">Tag of the stream.</param>
<param name="allocationStack">Stack of original allocation.</param>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamFinalizedEventArgs.Id">
<summary>
Unique ID for the stream.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamFinalizedEventArgs.Tag">
<summary>
Optional Tag for the event.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamFinalizedEventArgs.AllocationStack">
<summary>
Stack where the stream was allocated.
</summary>
</member>
<member name="T:Microsoft.IO.RecyclableMemoryStreamManager.StreamConvertedToArrayEventArgs">
<summary>
Arguments for the <see cref="E:Microsoft.IO.RecyclableMemoryStreamManager.StreamConvertedToArray"/> event.
</summary>
<remarks>
Initializes a new instance of the <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager.StreamConvertedToArrayEventArgs"/> class.
</remarks>
<param name="guid">Unique ID of the stream.</param>
<param name="tag">Tag of the stream.</param>
<param name="stack">Stack of ToArray call.</param>
<param name="length">Length of stream.</param>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.StreamConvertedToArrayEventArgs.#ctor(System.Guid,System.String,System.String,System.Int64)">
<summary>
Arguments for the <see cref="E:Microsoft.IO.RecyclableMemoryStreamManager.StreamConvertedToArray"/> event.
</summary>
<remarks>
Initializes a new instance of the <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager.StreamConvertedToArrayEventArgs"/> class.
</remarks>
<param name="guid">Unique ID of the stream.</param>
<param name="tag">Tag of the stream.</param>
<param name="stack">Stack of ToArray call.</param>
<param name="length">Length of stream.</param>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamConvertedToArrayEventArgs.Id">
<summary>
Unique ID for the stream.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamConvertedToArrayEventArgs.Tag">
<summary>
Optional Tag for the event.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamConvertedToArrayEventArgs.Stack">
<summary>
Stack where ToArray was called.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamConvertedToArrayEventArgs.Length">
<summary>
Length of stack.
</summary>
</member>
<member name="T:Microsoft.IO.RecyclableMemoryStreamManager.StreamOverCapacityEventArgs">
<summary>
Arguments for the <see cref="E:Microsoft.IO.RecyclableMemoryStreamManager.StreamOverCapacity"/> event.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamOverCapacityEventArgs.Id">
<summary>
Unique ID for the stream.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamOverCapacityEventArgs.Tag">
<summary>
Optional Tag for the event.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamOverCapacityEventArgs.AllocationStack">
<summary>
Original allocation stack.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamOverCapacityEventArgs.RequestedCapacity">
<summary>
Requested capacity.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamOverCapacityEventArgs.MaximumCapacity">
<summary>
Maximum capacity.
</summary>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.StreamOverCapacityEventArgs.#ctor(System.Guid,System.String,System.Int64,System.Int64,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager.StreamOverCapacityEventArgs"/> class.
</summary>
<param name="guid">Unique ID of the stream.</param>
<param name="tag">Tag of the stream.</param>
<param name="requestedCapacity">Requested capacity.</param>
<param name="maximumCapacity">Maximum stream capacity of the manager.</param>
<param name="allocationStack">Original allocation stack.</param>
</member>
<member name="T:Microsoft.IO.RecyclableMemoryStreamManager.BlockCreatedEventArgs">
<summary>
Arguments for the <see cref="E:Microsoft.IO.RecyclableMemoryStreamManager.BlockCreated"/> event.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.BlockCreatedEventArgs.SmallPoolInUse">
<summary>
How many bytes are currently in use from the small pool.
</summary>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.BlockCreatedEventArgs.#ctor(System.Int64)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager.BlockCreatedEventArgs"/> class.
</summary>
<param name="smallPoolInUse">Number of bytes currently in use from the small pool.</param>
</member>
<member name="T:Microsoft.IO.RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs">
<summary>
Arguments for the <see cref="E:Microsoft.IO.RecyclableMemoryStreamManager.LargeBufferCreated"/> events.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs.Id">
<summary>
Unique ID for the stream.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs.Tag">
<summary>
Optional Tag for the event.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs.Pooled">
<summary>
Whether the buffer was satisfied from the pool or not.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs.RequiredSize">
<summary>
Required buffer size.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs.LargePoolInUse">
<summary>
How many bytes are in use from the large pool.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs.CallStack">
<summary>
If the buffer was not satisfied from the pool, and <see cref="P:Microsoft.IO.RecyclableMemoryStreamManager.Options.GenerateCallStacks"/> is turned on, then.
this will contain the call stack of the allocation request.
</summary>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs.#ctor(System.Guid,System.String,System.Int64,System.Int64,System.Boolean,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs"/> class.
</summary>
<param name="guid">Unique ID of the stream.</param>
<param name="tag">Tag of the stream.</param>
<param name="requiredSize">Required size of the new buffer.</param>
<param name="largePoolInUse">How many bytes from the large pool are currently in use.</param>
<param name="pooled">Whether the buffer was satisfied from the pool or not.</param>
<param name="callStack">Call stack of the allocation, if it wasn't pooled.</param>
</member>
<member name="T:Microsoft.IO.RecyclableMemoryStreamManager.BufferDiscardedEventArgs">
<summary>
Arguments for the <see cref="E:Microsoft.IO.RecyclableMemoryStreamManager.BufferDiscarded"/> event.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.BufferDiscardedEventArgs.Id">
<summary>
Unique ID for the stream.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.BufferDiscardedEventArgs.Tag">
<summary>
Optional Tag for the event.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.BufferDiscardedEventArgs.BufferType">
<summary>
Type of the buffer.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.BufferDiscardedEventArgs.Reason">
<summary>
The reason this buffer was discarded.
</summary>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.BufferDiscardedEventArgs.#ctor(System.Guid,System.String,Microsoft.IO.RecyclableMemoryStreamManager.Events.MemoryStreamBufferType,Microsoft.IO.RecyclableMemoryStreamManager.Events.MemoryStreamDiscardReason)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager.BufferDiscardedEventArgs"/> class.
</summary>
<param name="guid">Unique ID of the stream.</param>
<param name="tag">Tag of the stream.</param>
<param name="bufferType">Type of buffer being discarded.</param>
<param name="reason">The reason for the discard.</param>
</member>
<member name="T:Microsoft.IO.RecyclableMemoryStreamManager.StreamLengthEventArgs">
<summary>
Arguments for the <see cref="E:Microsoft.IO.RecyclableMemoryStreamManager.StreamLength"/> event.
</summary>
<remarks>
Initializes a new instance of the <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager.StreamLengthEventArgs"/> class.
</remarks>
<param name="length">Length of the strength.</param>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.StreamLengthEventArgs.#ctor(System.Int64)">
<summary>
Arguments for the <see cref="E:Microsoft.IO.RecyclableMemoryStreamManager.StreamLength"/> event.
</summary>
<remarks>
Initializes a new instance of the <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager.StreamLengthEventArgs"/> class.
</remarks>
<param name="length">Length of the strength.</param>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.StreamLengthEventArgs.Length">
<summary>
Length of the stream.
</summary>
</member>
<member name="T:Microsoft.IO.RecyclableMemoryStreamManager.UsageReportEventArgs">
<summary>
Arguments for the <see cref="E:Microsoft.IO.RecyclableMemoryStreamManager.UsageReport"/> event.
</summary>
<remarks>
Initializes a new instance of the <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager.UsageReportEventArgs"/> class.
</remarks>
<param name="smallPoolInUseBytes">Bytes from the small pool currently in use.</param>
<param name="smallPoolFreeBytes">Bytes from the small pool currently available.</param>
<param name="largePoolInUseBytes">Bytes from the large pool currently in use.</param>
<param name="largePoolFreeBytes">Bytes from the large pool currently available.</param>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.UsageReportEventArgs.#ctor(System.Int64,System.Int64,System.Int64,System.Int64)">
<summary>
Arguments for the <see cref="E:Microsoft.IO.RecyclableMemoryStreamManager.UsageReport"/> event.
</summary>
<remarks>
Initializes a new instance of the <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager.UsageReportEventArgs"/> class.
</remarks>
<param name="smallPoolInUseBytes">Bytes from the small pool currently in use.</param>
<param name="smallPoolFreeBytes">Bytes from the small pool currently available.</param>
<param name="largePoolInUseBytes">Bytes from the large pool currently in use.</param>
<param name="largePoolFreeBytes">Bytes from the large pool currently available.</param>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.UsageReportEventArgs.SmallPoolInUseBytes">
<summary>
Bytes from the small pool currently in use.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.UsageReportEventArgs.SmallPoolFreeBytes">
<summary>
Bytes from the small pool currently available.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.UsageReportEventArgs.LargePoolInUseBytes">
<summary>
Bytes from the large pool currently in use.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.UsageReportEventArgs.LargePoolFreeBytes">
<summary>
Bytes from the large pool currently available.
</summary>
</member>
<member name="T:Microsoft.IO.RecyclableMemoryStreamManager.Events">
<summary>
ETW events for RecyclableMemoryStream.
</summary>
</member>
<member name="F:Microsoft.IO.RecyclableMemoryStreamManager.Events.Writer">
<summary>
Static log object, through which all events are written.
</summary>
</member>
<member name="T:Microsoft.IO.RecyclableMemoryStreamManager.Events.MemoryStreamBufferType">
<summary>
Type of buffer.
</summary>
</member>
<member name="F:Microsoft.IO.RecyclableMemoryStreamManager.Events.MemoryStreamBufferType.Small">
<summary>
Small block buffer.
</summary>
</member>
<member name="F:Microsoft.IO.RecyclableMemoryStreamManager.Events.MemoryStreamBufferType.Large">
<summary>
Large pool buffer.
</summary>
</member>
<member name="T:Microsoft.IO.RecyclableMemoryStreamManager.Events.MemoryStreamDiscardReason">
<summary>
The possible reasons for discarding a buffer.
</summary>
</member>
<member name="F:Microsoft.IO.RecyclableMemoryStreamManager.Events.MemoryStreamDiscardReason.TooLarge">
<summary>
Buffer was too large to be re-pooled.
</summary>
</member>
<member name="F:Microsoft.IO.RecyclableMemoryStreamManager.Events.MemoryStreamDiscardReason.EnoughFree">
<summary>
There are enough free bytes in the pool.
</summary>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.Events.MemoryStreamCreated(System.Guid,System.String,System.Int64,System.Int64)">
<summary>
Logged when a stream object is created.
</summary>
<param name="guid">A unique ID for this stream.</param>
<param name="tag">A temporary ID for this stream, usually indicates current usage.</param>
<param name="requestedSize">Requested size of the stream.</param>
<param name="actualSize">Actual size given to the stream from the pool.</param>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.Events.MemoryStreamDisposed(System.Guid,System.String,System.Int64,System.String,System.String)">
<summary>
Logged when the stream is disposed.
</summary>
<param name="guid">A unique ID for this stream.</param>
<param name="tag">A temporary ID for this stream, usually indicates current usage.</param>
<param name="lifetimeMs">Lifetime in milliseconds of the stream</param>
<param name="allocationStack">Call stack of initial allocation.</param>
<param name="disposeStack">Call stack of the dispose.</param>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.Events.MemoryStreamDoubleDispose(System.Guid,System.String,System.String,System.String,System.String)">
<summary>
Logged when the stream is disposed for the second time.
</summary>
<param name="guid">A unique ID for this stream.</param>
<param name="tag">A temporary ID for this stream, usually indicates current usage.</param>
<param name="allocationStack">Call stack of initial allocation.</param>
<param name="disposeStack1">Call stack of the first dispose.</param>
<param name="disposeStack2">Call stack of the second dispose.</param>
<remarks>Note: Stacks will only be populated if RecyclableMemoryStreamManager.GenerateCallStacks is true.</remarks>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.Events.MemoryStreamFinalized(System.Guid,System.String,System.String)">
<summary>
Logged when a stream is finalized.
</summary>
<param name="guid">A unique ID for this stream.</param>
<param name="tag">A temporary ID for this stream, usually indicates current usage.</param>
<param name="allocationStack">Call stack of initial allocation.</param>
<remarks>Note: Stacks will only be populated if RecyclableMemoryStreamManager.GenerateCallStacks is true.</remarks>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.Events.MemoryStreamToArray(System.Guid,System.String,System.String,System.Int64)">
<summary>
Logged when ToArray is called on a stream.
</summary>
<param name="guid">A unique ID for this stream.</param>
<param name="tag">A temporary ID for this stream, usually indicates current usage.</param>
<param name="stack">Call stack of the ToArray call.</param>
<param name="size">Length of stream.</param>
<remarks>Note: Stacks will only be populated if RecyclableMemoryStreamManager.GenerateCallStacks is true.</remarks>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.Events.MemoryStreamManagerInitialized(System.Int32,System.Int32,System.Int32)">
<summary>
Logged when the RecyclableMemoryStreamManager is initialized.
</summary>
<param name="blockSize">Size of blocks, in bytes.</param>
<param name="largeBufferMultiple">Size of the large buffer multiple, in bytes.</param>
<param name="maximumBufferSize">Maximum buffer size, in bytes.</param>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.Events.MemoryStreamNewBlockCreated(System.Int64)">
<summary>
Logged when a new block is created.
</summary>
<param name="smallPoolInUseBytes">Number of bytes in the small pool currently in use.</param>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.Events.MemoryStreamNewLargeBufferCreated(System.Int64,System.Int64)">
<summary>
Logged when a new large buffer is created.
</summary>
<param name="requiredSize">Requested size.</param>
<param name="largePoolInUseBytes">Number of bytes in the large pool in use.</param>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.Events.MemoryStreamNonPooledLargeBufferCreated(System.Guid,System.String,System.Int64,System.String)">
<summary>
Logged when a buffer is created that is too large to pool.
</summary>
<param name="guid">Unique stream ID.</param>
<param name="tag">A temporary ID for this stream, usually indicates current usage.</param>
<param name="requiredSize">Size requested by the caller.</param>
<param name="allocationStack">Call stack of the requested stream.</param>
<remarks>Note: Stacks will only be populated if RecyclableMemoryStreamManager.GenerateCallStacks is true.</remarks>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.Events.MemoryStreamDiscardBuffer(System.Guid,System.String,Microsoft.IO.RecyclableMemoryStreamManager.Events.MemoryStreamBufferType,Microsoft.IO.RecyclableMemoryStreamManager.Events.MemoryStreamDiscardReason,System.Int64,System.Int64,System.Int64,System.Int64,System.Int64,System.Int64)">
<summary>
Logged when a buffer is discarded (not put back in the pool, but given to GC to clean up).
</summary>
<param name="guid">Unique stream ID.</param>
<param name="tag">A temporary ID for this stream, usually indicates current usage.</param>
<param name="bufferType">Type of the buffer being discarded.</param>
<param name="reason">Reason for the discard.</param>
<param name="smallBlocksFree">Number of free small pool blocks.</param>
<param name="smallPoolBytesFree">Bytes free in the small pool.</param>
<param name="smallPoolBytesInUse">Bytes in use from the small pool.</param>
<param name="largeBlocksFree">Number of free large pool blocks.</param>
<param name="largePoolBytesFree">Bytes free in the large pool.</param>
<param name="largePoolBytesInUse">Bytes in use from the large pool.</param>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.Events.MemoryStreamOverCapacity(System.Guid,System.String,System.Int64,System.Int64,System.String)">
<summary>
Logged when a stream grows beyond the maximum capacity.
</summary>
<param name="guid">Unique stream ID</param>
<param name="requestedCapacity">The requested capacity.</param>
<param name="maxCapacity">Maximum capacity, as configured by RecyclableMemoryStreamManager.</param>
<param name="tag">A temporary ID for this stream, usually indicates current usage.</param>
<param name="allocationStack">Call stack for the capacity request.</param>
<remarks>Note: Stacks will only be populated if RecyclableMemoryStreamManager.GenerateCallStacks is true.</remarks>
</member>
<member name="F:Microsoft.IO.RecyclableMemoryStreamManager.MaxArrayLength">
<summary>
Maximum length of a single array.
</summary>
<remarks>See documentation at https://docs.microsoft.com/dotnet/api/system.array?view=netcore-3.1
</remarks>
</member>
<member name="F:Microsoft.IO.RecyclableMemoryStreamManager.DefaultBlockSize">
<summary>
Default block size, in bytes.
</summary>
</member>
<member name="F:Microsoft.IO.RecyclableMemoryStreamManager.DefaultLargeBufferMultiple">
<summary>
Default large buffer multiple, in bytes.
</summary>
</member>
<member name="F:Microsoft.IO.RecyclableMemoryStreamManager.DefaultMaximumBufferSize">
<summary>
Default maximum buffer size, in bytes.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.Settings">
<summary>
Settings for controlling the behavior of RecyclableMemoryStream
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.SmallPoolFreeSize">
<summary>
Number of bytes in small pool not currently in use.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.SmallPoolInUseSize">
<summary>
Number of bytes currently in use by stream from the small pool.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.LargePoolFreeSize">
<summary>
Number of bytes in large pool not currently in use.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.LargePoolInUseSize">
<summary>
Number of bytes currently in use by streams from the large pool.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.SmallBlocksFree">
<summary>
How many blocks are in the small pool.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.LargeBuffersFree">
<summary>
How many buffers are in the large pool.
</summary>
</member>
<member name="T:Microsoft.IO.RecyclableMemoryStreamManager.Options">
<summary>
Parameters for customizing the behavior of <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager"/>
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.Options.BlockSize">
<summary>
Gets or sets the size of the pooled blocks. This must be greater than 0.
</summary>
<remarks>The default size 131,072 (128KB)</remarks>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.Options.LargeBufferMultiple">
<summary>
Each large buffer will be a multiple exponential of this value
</summary>
<remarks>The default value is 1,048,576 (1MB)</remarks>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.Options.MaximumBufferSize">
<summary>
Buffer beyond this length are not pooled.
</summary>
<remarks>The default value is 134,217,728 (128MB)</remarks>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.Options.MaximumSmallPoolFreeBytes">
<summary>
Maximum number of bytes to keep available in the small pool.
</summary>
<remarks>
<para>Trying to return buffers to the pool beyond this limit will result in them being garbage collected.</para>
<para>The default value is 0, but all users should set a reasonable value depending on your application's memory requirements.</para>
</remarks>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.Options.MaximumLargePoolFreeBytes">
<summary>
Maximum number of bytes to keep available in the large pools.
</summary>
<remarks>
<para>Trying to return buffers to the pool beyond this limit will result in them being garbage collected.</para>
<para>The default value is 0, but all users should set a reasonable value depending on your application's memory requirements.</para>
</remarks>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.Options.UseExponentialLargeBuffer">
<summary>
Whether to use the exponential allocation strategy (see documentation).
</summary>
<remarks>The default value is false.</remarks>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.Options.MaximumStreamCapacity">
<summary>
Maximum stream capacity in bytes. Attempts to set a larger capacity will
result in an exception.
</summary>
<remarks>The default value of 0 indicates no limit.</remarks>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.Options.GenerateCallStacks">
<summary>
Whether to save call stacks for stream allocations. This can help in debugging.
It should NEVER be turned on generally in production.
</summary>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.Options.AggressiveBufferReturn">
<summary>
Whether dirty buffers can be immediately returned to the buffer pool.
</summary>
<remarks>
<para>
When <see cref="M:Microsoft.IO.RecyclableMemoryStream.GetBuffer"/> is called on a stream and creates a single large buffer, if this setting is enabled, the other blocks will be returned
to the buffer pool immediately.
</para>
<para>
Note when enabling this setting that the user is responsible for ensuring that any buffer previously
retrieved from a stream which is subsequently modified is not used after modification (as it may no longer
be valid).
</para>
</remarks>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.Options.ThrowExceptionOnToArray">
<summary>
Causes an exception to be thrown if <see cref="M:Microsoft.IO.RecyclableMemoryStream.ToArray"/> is ever called.
</summary>
<remarks>Calling <see cref="M:Microsoft.IO.RecyclableMemoryStream.ToArray"/> defeats the purpose of a pooled buffer. Use this property to discover code that is calling <see cref="M:Microsoft.IO.RecyclableMemoryStream.ToArray"/>. If this is
set and <see cref="M:Microsoft.IO.RecyclableMemoryStream.ToArray"/> is called, a <c>NotSupportedException</c> will be thrown.</remarks>
</member>
<member name="P:Microsoft.IO.RecyclableMemoryStreamManager.Options.ZeroOutBuffer">
<summary>
Zero out buffers on allocation and before returning them to the pool.
</summary>
<remarks>Setting this to true causes a performance hit and should only be set if one wants to avoid accidental data leaks.</remarks>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.Options.#ctor">
<summary>
Creates a new <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager.Options"/> object.
</summary>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.Options.#ctor(System.Int32,System.Int32,System.Int32,System.Int64,System.Int64)">
<summary>
Creates a new <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager.Options"/> object with the most common options.
</summary>
<param name="blockSize">Size of the blocks in the small pool.</param>
<param name="largeBufferMultiple">Size of the large buffer multiple</param>
<param name="maximumBufferSize">Maximum poolable buffer size.</param>
<param name="maximumSmallPoolFreeBytes">Maximum bytes to hold in the small pool.</param>
<param name="maximumLargePoolFreeBytes">Maximum bytes to hold in each of the large pools.</param>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.#ctor">
<summary>
Initializes the memory manager with the default block/buffer specifications. This pool may have unbounded growth unless you modify <see cref="T:Microsoft.IO.RecyclableMemoryStreamManager.Options"/>.
</summary>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.#ctor(Microsoft.IO.RecyclableMemoryStreamManager.Options)">
<summary>
Initializes the memory manager with the given block requiredSize.
</summary>
<param name="options">Object specifying options for stream behavior.</param>
<exception cref="T:System.InvalidOperationException">
<paramref name="options.BlockSize.BlockSize"/> is not a positive number,
or <paramref name="options.LargeBufferMultiple.LargeBufferMultiple"/> is not a positive number,
or <paramref name="options.MaximumBufferSize.MaximumBufferSize"/> is less than options.BlockSize,
or <paramref name="options.MaximumSmallPoolFreeBytes.MaximumSmallPoolFreeBytes"/> is negative,
or <paramref name="options.MaximumLargePoolFreeBytes.MaximumLargePoolFreeBytes"/> is negative,
or <paramref name="options.MaximumBufferSize.MaximumBufferSize"/> is not a multiple/exponential of <paramref name="options.LargeBufferMultiple.LargeBufferMultiple"/>.
</exception>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.GetBlock">
<summary>
Removes and returns a single block from the pool.
</summary>
<returns>A <c>byte[]</c> array.</returns>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.GetLargeBuffer(System.Int64,System.Guid,System.String)">
<summary>
Returns a buffer of arbitrary size from the large buffer pool. This buffer
will be at least the requiredSize and always be a multiple/exponential of largeBufferMultiple.
</summary>
<param name="requiredSize">The minimum length of the buffer.</param>
<param name="id">Unique ID for the stream.</param>
<param name="tag">The tag of the stream returning this buffer, for logging if necessary.</param>
<returns>A buffer of at least the required size.</returns>
<exception cref="T:System.OutOfMemoryException">Requested array size is larger than the maximum allowed.</exception>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.ReturnLargeBuffer(System.Byte[],System.Guid,System.String)">
<summary>
Returns the buffer to the large pool.
</summary>
<param name="buffer">The buffer to return.</param>
<param name="id">Unique stream ID.</param>
<param name="tag">The tag of the stream returning this buffer, for logging if necessary.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="buffer"/> is null.</exception>
<exception cref="T:System.ArgumentException"><c>buffer.Length</c> is not a multiple/exponential of <see cref="P:Microsoft.IO.RecyclableMemoryStreamManager.Options.LargeBufferMultiple"/> (it did not originate from this pool).</exception>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.ReturnBlocks(System.Collections.Generic.List{System.Byte[]},System.Guid,System.String)">
<summary>
Returns the blocks to the pool.
</summary>
<param name="blocks">Collection of blocks to return to the pool.</param>
<param name="id">Unique Stream ID.</param>
<param name="tag">The tag of the stream returning these blocks, for logging if necessary.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="blocks"/> is null.</exception>
<exception cref="T:System.ArgumentException"><paramref name="blocks"/> contains buffers that are the wrong size (or null) for this memory manager.</exception>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.ReturnBlock(System.Byte[],System.Guid,System.String)">
<summary>
Returns a block to the pool.
</summary>
<param name="block">Block to return to the pool.</param>
<param name="id">Unique Stream ID.</param>
<param name="tag">The tag of the stream returning this, for logging if necessary.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="block"/> is null.</exception>
<exception cref="T:System.ArgumentException"><paramref name="block"/> is the wrong size for this memory manager.</exception>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.GetStream">
<summary>
Retrieve a new <see cref="T:Microsoft.IO.RecyclableMemoryStream"/> object with no tag and a default initial capacity.
</summary>
<returns>A <see cref="T:Microsoft.IO.RecyclableMemoryStream"/>.</returns>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.GetStream(System.Guid)">
<summary>
Retrieve a new <see cref="T:Microsoft.IO.RecyclableMemoryStream"/> object with no tag and a default initial capacity.
</summary>
<param name="id">A unique identifier which can be used to trace usages of the stream.</param>
<returns>A <see cref="T:Microsoft.IO.RecyclableMemoryStream"/>.</returns>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.GetStream(System.String)">
<summary>
Retrieve a new <see cref="T:Microsoft.IO.RecyclableMemoryStream"/> object with the given tag and a default initial capacity.
</summary>
<param name="tag">A tag which can be used to track the source of the stream.</param>
<returns>A <see cref="T:Microsoft.IO.RecyclableMemoryStream"/>.</returns>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.GetStream(System.Guid,System.String)">
<summary>
Retrieve a new <see cref="T:Microsoft.IO.RecyclableMemoryStream"/> object with the given tag and a default initial capacity.
</summary>
<param name="id">A unique identifier which can be used to trace usages of the stream.</param>
<param name="tag">A tag which can be used to track the source of the stream.</param>
<returns>A <see cref="T:Microsoft.IO.RecyclableMemoryStream"/>.</returns>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.GetStream(System.String,System.Int64)">
<summary>
Retrieve a new <see cref="T:Microsoft.IO.RecyclableMemoryStream"/> object with the given tag and at least the given capacity.
</summary>
<param name="tag">A tag which can be used to track the source of the stream.</param>
<param name="requiredSize">The minimum desired capacity for the stream.</param>
<returns>A <see cref="T:Microsoft.IO.RecyclableMemoryStream"/>.</returns>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.GetStream(System.Guid,System.String,System.Int64)">
<summary>
Retrieve a new <see cref="T:Microsoft.IO.RecyclableMemoryStream"/> object with the given tag and at least the given capacity.
</summary>
<param name="id">A unique identifier which can be used to trace usages of the stream.</param>
<param name="tag">A tag which can be used to track the source of the stream.</param>
<param name="requiredSize">The minimum desired capacity for the stream.</param>
<returns>A <see cref="T:Microsoft.IO.RecyclableMemoryStream"/>.</returns>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.GetStream(System.Guid,System.String,System.Int64,System.Boolean)">
<summary>
Retrieve a new <see cref="T:Microsoft.IO.RecyclableMemoryStream"/> object with the given tag and at least the given capacity, possibly using
a single contiguous underlying buffer.
</summary>
<remarks>Retrieving a <see cref="T:Microsoft.IO.RecyclableMemoryStream"/> which provides a single contiguous buffer can be useful in situations
where the initial size is known and it is desirable to avoid copying data between the smaller underlying
buffers to a single large one. This is most helpful when you know that you will always call <see cref="M:Microsoft.IO.RecyclableMemoryStream.GetBuffer"/>
on the underlying stream.</remarks>
<param name="id">A unique identifier which can be used to trace usages of the stream.</param>
<param name="tag">A tag which can be used to track the source of the stream.</param>
<param name="requiredSize">The minimum desired capacity for the stream.</param>
<param name="asContiguousBuffer">Whether to attempt to use a single contiguous buffer.</param>
<returns>A <see cref="T:Microsoft.IO.RecyclableMemoryStream"/>.</returns>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.GetStream(System.String,System.Int64,System.Boolean)">
<summary>
Retrieve a new <see cref="T:Microsoft.IO.RecyclableMemoryStream"/> object with the given tag and at least the given capacity, possibly using
a single contiguous underlying buffer.
</summary>
<remarks>Retrieving a <see cref="T:Microsoft.IO.RecyclableMemoryStream"/> which provides a single contiguous buffer can be useful in situations
where the initial size is known and it is desirable to avoid copying data between the smaller underlying
buffers to a single large one. This is most helpful when you know that you will always call <see cref="M:Microsoft.IO.RecyclableMemoryStream.GetBuffer"/>
on the underlying stream.</remarks>
<param name="tag">A tag which can be used to track the source of the stream.</param>
<param name="requiredSize">The minimum desired capacity for the stream.</param>
<param name="asContiguousBuffer">Whether to attempt to use a single contiguous buffer.</param>
<returns>A <see cref="T:Microsoft.IO.RecyclableMemoryStream"/>.</returns>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.GetStream(System.Guid,System.String,System.Byte[],System.Int32,System.Int32)">
<summary>
Retrieve a new <see cref="T:Microsoft.IO.RecyclableMemoryStream"/> object with the given tag and with contents copied from the provided
buffer. The provided buffer is not wrapped or used after construction.
</summary>
<remarks>The new stream's position is set to the beginning of the stream when returned.</remarks>
<param name="id">A unique identifier which can be used to trace usages of the stream.</param>
<param name="tag">A tag which can be used to track the source of the stream.</param>
<param name="buffer">The byte buffer to copy data from.</param>
<param name="offset">The offset from the start of the buffer to copy from.</param>
<param name="count">The number of bytes to copy from the buffer.</param>
<returns>A <see cref="T:Microsoft.IO.RecyclableMemoryStream"/>.</returns>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.GetStream(System.Byte[])">
<summary>
Retrieve a new <see cref="T:Microsoft.IO.RecyclableMemoryStream"/> object with the contents copied from the provided
buffer. The provided buffer is not wrapped or used after construction.
</summary>
<remarks>The new stream's position is set to the beginning of the stream when returned.</remarks>
<param name="buffer">The byte buffer to copy data from.</param>
<returns>A <see cref="T:Microsoft.IO.RecyclableMemoryStream"/>.</returns>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.GetStream(System.String,System.Byte[],System.Int32,System.Int32)">
<summary>
Retrieve a new <see cref="T:Microsoft.IO.RecyclableMemoryStream"/> object with the given tag and with contents copied from the provided
buffer. The provided buffer is not wrapped or used after construction.
</summary>
<remarks>The new stream's position is set to the beginning of the stream when returned.</remarks>
<param name="tag">A tag which can be used to track the source of the stream.</param>
<param name="buffer">The byte buffer to copy data from.</param>
<param name="offset">The offset from the start of the buffer to copy from.</param>
<param name="count">The number of bytes to copy from the buffer.</param>
<returns>A <see cref="T:Microsoft.IO.RecyclableMemoryStream"/>.</returns>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.GetStream(System.Guid,System.String,System.ReadOnlySpan{System.Byte})">
<summary>
Retrieve a new <see cref="T:Microsoft.IO.RecyclableMemoryStream"/> object with the given tag and with contents copied from the provided
buffer. The provided buffer is not wrapped or used after construction.
</summary>
<remarks>The new stream's position is set to the beginning of the stream when returned.</remarks>
<param name="id">A unique identifier which can be used to trace usages of the stream.</param>
<param name="tag">A tag which can be used to track the source of the stream.</param>
<param name="buffer">The byte buffer to copy data from.</param>
<returns>A <see cref="T:Microsoft.IO.RecyclableMemoryStream"/>.</returns>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.GetStream(System.ReadOnlySpan{System.Byte})">
<summary>
Retrieve a new <see cref="T:Microsoft.IO.RecyclableMemoryStream"/> object with the contents copied from the provided
buffer. The provided buffer is not wrapped or used after construction.
</summary>
<remarks>The new stream's position is set to the beginning of the stream when returned.</remarks>
<param name="buffer">The byte buffer to copy data from.</param>
<returns>A <see cref="T:Microsoft.IO.RecyclableMemoryStream"/>.</returns>
</member>
<member name="M:Microsoft.IO.RecyclableMemoryStreamManager.GetStream(System.String,System.ReadOnlySpan{System.Byte})">
<summary>
Retrieve a new <see cref="T:Microsoft.IO.RecyclableMemoryStream"/> object with the given tag and with contents copied from the provided
buffer. The provided buffer is not wrapped or used after construction.
</summary>
<remarks>The new stream's position is set to the beginning of the stream when returned.</remarks>
<param name="tag">A tag which can be used to track the source of the stream.</param>
<param name="buffer">The byte buffer to copy data from.</param>
<returns>A <see cref="T:Microsoft.IO.RecyclableMemoryStream"/>.</returns>
</member>
<member name="E:Microsoft.IO.RecyclableMemoryStreamManager.BlockCreated">
<summary>
Triggered when a new block is created.
</summary>
</member>
<member name="E:Microsoft.IO.RecyclableMemoryStreamManager.LargeBufferCreated">
<summary>
Triggered when a new large buffer is created.
</summary>
</member>
<member name="E:Microsoft.IO.RecyclableMemoryStreamManager.StreamCreated">
<summary>
Triggered when a new stream is created.
</summary>
</member>
<member name="E:Microsoft.IO.RecyclableMemoryStreamManager.StreamDisposed">
<summary>
Triggered when a stream is disposed.
</summary>
</member>
<member name="E:Microsoft.IO.RecyclableMemoryStreamManager.StreamDoubleDisposed">
<summary>
Triggered when a stream is disposed of twice (an error).
</summary>
</member>
<member name="E:Microsoft.IO.RecyclableMemoryStreamManager.StreamFinalized">
<summary>
Triggered when a stream is finalized.
</summary>
</member>
<member name="E:Microsoft.IO.RecyclableMemoryStreamManager.StreamLength">
<summary>
Triggered when a stream is disposed to report the stream's length.
</summary>
</member>
<member name="E:Microsoft.IO.RecyclableMemoryStreamManager.StreamConvertedToArray">