Skip to content

Commit 55f2113

Browse files
TwoTenPvPTwoTenPvP
committed
docs: Updated API reference
1 parent 29a03f0 commit 55f2113

File tree

163 files changed

+33284
-31364
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

163 files changed

+33284
-31364
lines changed

‎docs/_api/Arithmetic.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,6 @@ permalink: /api/arithmetic/
5959
<br>
6060
<div>
6161
<h3 markdown="1">Inherited Methods</h3>
62-
<div style="line-height: 1;">
63-
<h4 markdown="1"><b>public ``string`` ToString();</b></h4>
64-
<h5 markdown="1">Inherited from: ``object``</h5>
65-
</div>
66-
<br>
6762
<div style="line-height: 1;">
6863
<h4 markdown="1"><b>public ``bool`` Equals(``object`` obj);</b></h4>
6964
<h5 markdown="1">Inherited from: ``object``</h5>
@@ -82,5 +77,10 @@ permalink: /api/arithmetic/
8277
<h4 markdown="1"><b>public ``Type`` GetType();</b></h4>
8378
<h5 markdown="1">Inherited from: ``object``</h5>
8479
</div>
80+
<br>
81+
<div style="line-height: 1;">
82+
<h4 markdown="1"><b>public ``string`` ToString();</b></h4>
83+
<h5 markdown="1">Inherited from: ``object``</h5>
84+
</div>
8585
</div>
8686
<br>

‎docs/_api/AutoBitWritable.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,6 @@ permalink: /api/auto-bit-writable/
3737
<br>
3838
<div>
3939
<h3 markdown="1">Inherited Methods</h3>
40-
<div style="line-height: 1;">
41-
<h4 markdown="1"><b>public ``string`` ToString();</b></h4>
42-
<h5 markdown="1">Inherited from: ``object``</h5>
43-
</div>
44-
<br>
4540
<div style="line-height: 1;">
4641
<h4 markdown="1"><b>public ``bool`` Equals(``object`` obj);</b></h4>
4742
<h5 markdown="1">Inherited from: ``object``</h5>
@@ -60,5 +55,10 @@ permalink: /api/auto-bit-writable/
6055
<h4 markdown="1"><b>public ``Type`` GetType();</b></h4>
6156
<h5 markdown="1">Inherited from: ``object``</h5>
6257
</div>
58+
<br>
59+
<div style="line-height: 1;">
60+
<h4 markdown="1"><b>public ``string`` ToString();</b></h4>
61+
<h5 markdown="1">Inherited from: ``object``</h5>
62+
</div>
6363
</div>
6464
<br>

‎docs/_api/BitReader.md

Lines changed: 77 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -26,78 +26,6 @@ permalink: /api/bit-reader/
2626
<br>
2727
<div>
2828
<h3 markdown="1">Public Methods</h3>
29-
<div style="line-height: 1;">
30-
<h4 markdown="1"><b>public ``double[]`` ReadDoubleArray(``double[]`` readTo, ``long`` knownLength);</b></h4>
31-
<p>Read double array from the stream.</p>
32-
<h5><b>Parameters</b></h5>
33-
<div>
34-
<p style="font-size: 20px; color: #444;" markdown="1">``double[]`` readTo</p>
35-
<p>The buffer to read into or null to create a new array</p>
36-
</div>
37-
<div>
38-
<p style="font-size: 20px; color: #444;" markdown="1">``long`` knownLength</p>
39-
<p>The known length or -1 if unknown</p>
40-
</div>
41-
<h5 markdown="1"><b>Returns ``double[]``</b></h5>
42-
<div>
43-
<p>The array read from the stream.</p>
44-
</div>
45-
</div>
46-
<br>
47-
<div style="line-height: 1;">
48-
<h4 markdown="1"><b>public ``double[]`` ReadDoubleArrayPacked(``double[]`` readTo, ``long`` knownLength);</b></h4>
49-
<p>Read double array in a packed format from the stream.</p>
50-
<h5><b>Parameters</b></h5>
51-
<div>
52-
<p style="font-size: 20px; color: #444;" markdown="1">``double[]`` readTo</p>
53-
<p>The buffer to read into or null to create a new array</p>
54-
</div>
55-
<div>
56-
<p style="font-size: 20px; color: #444;" markdown="1">``long`` knownLength</p>
57-
<p>The known length or -1 if unknown</p>
58-
</div>
59-
<h5 markdown="1"><b>Returns ``double[]``</b></h5>
60-
<div>
61-
<p>The array read from the stream.</p>
62-
</div>
63-
</div>
64-
<br>
65-
<div style="line-height: 1;">
66-
<h4 markdown="1"><b>public ``double[]`` ReadDoubleArrayDiff(``double[]`` readTo, ``long`` knownLength);</b></h4>
67-
<p>Read double array diff from the stream.</p>
68-
<h5><b>Parameters</b></h5>
69-
<div>
70-
<p style="font-size: 20px; color: #444;" markdown="1">``double[]`` readTo</p>
71-
<p>The buffer containing the old version or null.</p>
72-
</div>
73-
<div>
74-
<p style="font-size: 20px; color: #444;" markdown="1">``long`` knownLength</p>
75-
<p>The known length or -1 if unknown</p>
76-
</div>
77-
<h5 markdown="1"><b>Returns ``double[]``</b></h5>
78-
<div>
79-
<p>The array created from the diff and the current version.</p>
80-
</div>
81-
</div>
82-
<br>
83-
<div style="line-height: 1;">
84-
<h4 markdown="1"><b>public ``double[]`` ReadDoubleArrayPackedDiff(``double[]`` readTo, ``long`` knownLength);</b></h4>
85-
<p>Read double array diff in a packed format from the stream.</p>
86-
<h5><b>Parameters</b></h5>
87-
<div>
88-
<p style="font-size: 20px; color: #444;" markdown="1">``double[]`` readTo</p>
89-
<p>The buffer containing the old version or null.</p>
90-
</div>
91-
<div>
92-
<p style="font-size: 20px; color: #444;" markdown="1">``long`` knownLength</p>
93-
<p>The known length or -1 if unknown</p>
94-
</div>
95-
<h5 markdown="1"><b>Returns ``double[]``</b></h5>
96-
<div>
97-
<p>The array created from the diff and the current version.</p>
98-
</div>
99-
</div>
100-
<br>
10129
<div style="line-height: 1;">
10230
<h4 markdown="1"><b>public ``void`` SetStream(``Stream`` stream);</b></h4>
10331
<p>Changes the underlying stream the reader is reading from</p>
@@ -1231,15 +1159,82 @@ permalink: /api/bit-reader/
12311159
</div>
12321160
</div>
12331161
<br>
1162+
<div style="line-height: 1;">
1163+
<h4 markdown="1"><b>public ``double[]`` ReadDoubleArray(``double[]`` readTo, ``long`` knownLength);</b></h4>
1164+
<p>Read double array from the stream.</p>
1165+
<h5><b>Parameters</b></h5>
1166+
<div>
1167+
<p style="font-size: 20px; color: #444;" markdown="1">``double[]`` readTo</p>
1168+
<p>The buffer to read into or null to create a new array</p>
1169+
</div>
1170+
<div>
1171+
<p style="font-size: 20px; color: #444;" markdown="1">``long`` knownLength</p>
1172+
<p>The known length or -1 if unknown</p>
1173+
</div>
1174+
<h5 markdown="1"><b>Returns ``double[]``</b></h5>
1175+
<div>
1176+
<p>The array read from the stream.</p>
1177+
</div>
1178+
</div>
1179+
<br>
1180+
<div style="line-height: 1;">
1181+
<h4 markdown="1"><b>public ``double[]`` ReadDoubleArrayPacked(``double[]`` readTo, ``long`` knownLength);</b></h4>
1182+
<p>Read double array in a packed format from the stream.</p>
1183+
<h5><b>Parameters</b></h5>
1184+
<div>
1185+
<p style="font-size: 20px; color: #444;" markdown="1">``double[]`` readTo</p>
1186+
<p>The buffer to read into or null to create a new array</p>
1187+
</div>
1188+
<div>
1189+
<p style="font-size: 20px; color: #444;" markdown="1">``long`` knownLength</p>
1190+
<p>The known length or -1 if unknown</p>
1191+
</div>
1192+
<h5 markdown="1"><b>Returns ``double[]``</b></h5>
1193+
<div>
1194+
<p>The array read from the stream.</p>
1195+
</div>
1196+
</div>
1197+
<br>
1198+
<div style="line-height: 1;">
1199+
<h4 markdown="1"><b>public ``double[]`` ReadDoubleArrayDiff(``double[]`` readTo, ``long`` knownLength);</b></h4>
1200+
<p>Read double array diff from the stream.</p>
1201+
<h5><b>Parameters</b></h5>
1202+
<div>
1203+
<p style="font-size: 20px; color: #444;" markdown="1">``double[]`` readTo</p>
1204+
<p>The buffer containing the old version or null.</p>
1205+
</div>
1206+
<div>
1207+
<p style="font-size: 20px; color: #444;" markdown="1">``long`` knownLength</p>
1208+
<p>The known length or -1 if unknown</p>
1209+
</div>
1210+
<h5 markdown="1"><b>Returns ``double[]``</b></h5>
1211+
<div>
1212+
<p>The array created from the diff and the current version.</p>
1213+
</div>
1214+
</div>
1215+
<br>
1216+
<div style="line-height: 1;">
1217+
<h4 markdown="1"><b>public ``double[]`` ReadDoubleArrayPackedDiff(``double[]`` readTo, ``long`` knownLength);</b></h4>
1218+
<p>Read double array diff in a packed format from the stream.</p>
1219+
<h5><b>Parameters</b></h5>
1220+
<div>
1221+
<p style="font-size: 20px; color: #444;" markdown="1">``double[]`` readTo</p>
1222+
<p>The buffer containing the old version or null.</p>
1223+
</div>
1224+
<div>
1225+
<p style="font-size: 20px; color: #444;" markdown="1">``long`` knownLength</p>
1226+
<p>The known length or -1 if unknown</p>
1227+
</div>
1228+
<h5 markdown="1"><b>Returns ``double[]``</b></h5>
1229+
<div>
1230+
<p>The array created from the diff and the current version.</p>
1231+
</div>
1232+
</div>
1233+
<br>
12341234
</div>
12351235
<br>
12361236
<div>
12371237
<h3 markdown="1">Inherited Methods</h3>
1238-
<div style="line-height: 1;">
1239-
<h4 markdown="1"><b>public ``string`` ToString();</b></h4>
1240-
<h5 markdown="1">Inherited from: ``object``</h5>
1241-
</div>
1242-
<br>
12431238
<div style="line-height: 1;">
12441239
<h4 markdown="1"><b>public ``bool`` Equals(``object`` obj);</b></h4>
12451240
<h5 markdown="1">Inherited from: ``object``</h5>
@@ -1258,5 +1253,10 @@ permalink: /api/bit-reader/
12581253
<h4 markdown="1"><b>public ``Type`` GetType();</b></h4>
12591254
<h5 markdown="1">Inherited from: ``object``</h5>
12601255
</div>
1256+
<br>
1257+
<div style="line-height: 1;">
1258+
<h4 markdown="1"><b>public ``string`` ToString();</b></h4>
1259+
<h5 markdown="1">Inherited from: ``object``</h5>
1260+
</div>
12611261
</div>
12621262
<br>

‎docs/_api/BitReaderPool.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,6 @@ permalink: /api/bit-reader-pool/
4141
<br>
4242
<div>
4343
<h3 markdown="1">Inherited Methods</h3>
44-
<div style="line-height: 1;">
45-
<h4 markdown="1"><b>public ``string`` ToString();</b></h4>
46-
<h5 markdown="1">Inherited from: ``object``</h5>
47-
</div>
48-
<br>
4944
<div style="line-height: 1;">
5045
<h4 markdown="1"><b>public ``bool`` Equals(``object`` obj);</b></h4>
5146
<h5 markdown="1">Inherited from: ``object``</h5>
@@ -64,5 +59,10 @@ permalink: /api/bit-reader-pool/
6459
<h4 markdown="1"><b>public ``Type`` GetType();</b></h4>
6560
<h5 markdown="1">Inherited from: ``object``</h5>
6661
</div>
62+
<br>
63+
<div style="line-height: 1;">
64+
<h4 markdown="1"><b>public ``string`` ToString();</b></h4>
65+
<h5 markdown="1">Inherited from: ``object``</h5>
66+
</div>
6767
</div>
6868
<br>

‎docs/_api/BitStream.md

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -569,13 +569,45 @@ permalink: /api/bit-stream/
569569
</div>
570570
<br>
571571
<div style="line-height: 1;">
572-
<h4 markdown="1"><b>public ``object`` GetLifetimeService();</b></h4>
573-
<h5 markdown="1">Inherited from: ``MarshalByRefObject``</h5>
572+
<h4 markdown="1"><b>public ``int`` Read(``Span<byte>`` destination);</b></h4>
573+
<h5 markdown="1">Inherited from: ``Stream``</h5>
574+
<h5><b>Parameters</b></h5>
575+
<div>
576+
<p style="font-size: 20px; color: #444;" markdown="1">``Span<byte>`` destination</p>
577+
</div>
574578
</div>
575579
<br>
576580
<div style="line-height: 1;">
577-
<h4 markdown="1"><b>public ``object`` InitializeLifetimeService();</b></h4>
578-
<h5 markdown="1">Inherited from: ``MarshalByRefObject``</h5>
581+
<h4 markdown="1"><b>public ``void`` Write(``ReadOnlySpan<byte>`` source);</b></h4>
582+
<h5 markdown="1">Inherited from: ``Stream``</h5>
583+
<h5><b>Parameters</b></h5>
584+
<div>
585+
<p style="font-size: 20px; color: #444;" markdown="1">``ReadOnlySpan<byte>`` source</p>
586+
</div>
587+
</div>
588+
<br>
589+
<div style="line-height: 1;">
590+
<h4 markdown="1"><b>public ``ValueTask<int>`` ReadAsync(``Memory<byte>`` destination, ``CancellationToken`` cancellationToken);</b></h4>
591+
<h5 markdown="1">Inherited from: ``Stream``</h5>
592+
<h5><b>Parameters</b></h5>
593+
<div>
594+
<p style="font-size: 20px; color: #444;" markdown="1">``Memory<byte>`` destination</p>
595+
</div>
596+
<div>
597+
<p style="font-size: 20px; color: #444;" markdown="1">``CancellationToken`` cancellationToken</p>
598+
</div>
599+
</div>
600+
<br>
601+
<div style="line-height: 1;">
602+
<h4 markdown="1"><b>public ``ValueTask`` WriteAsync(``ReadOnlyMemory<byte>`` source, ``CancellationToken`` cancellationToken);</b></h4>
603+
<h5 markdown="1">Inherited from: ``Stream``</h5>
604+
<h5><b>Parameters</b></h5>
605+
<div>
606+
<p style="font-size: 20px; color: #444;" markdown="1">``ReadOnlyMemory<byte>`` source</p>
607+
</div>
608+
<div>
609+
<p style="font-size: 20px; color: #444;" markdown="1">``CancellationToken`` cancellationToken</p>
610+
</div>
579611
</div>
580612
<br>
581613
<div style="line-height: 1;">
@@ -587,6 +619,16 @@ permalink: /api/bit-stream/
587619
</div>
588620
</div>
589621
<br>
622+
<div style="line-height: 1;">
623+
<h4 markdown="1"><b>public ``object`` GetLifetimeService();</b></h4>
624+
<h5 markdown="1">Inherited from: ``MarshalByRefObject``</h5>
625+
</div>
626+
<br>
627+
<div style="line-height: 1;">
628+
<h4 markdown="1"><b>public ``object`` InitializeLifetimeService();</b></h4>
629+
<h5 markdown="1">Inherited from: ``MarshalByRefObject``</h5>
630+
</div>
631+
<br>
590632
<div style="line-height: 1;">
591633
<h4 markdown="1"><b>public ``bool`` Equals(``object`` obj);</b></h4>
592634
<h5 markdown="1">Inherited from: ``object``</h5>

‎docs/_api/BitStreamPool.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,6 @@ permalink: /api/bit-stream-pool/
3636
<br>
3737
<div>
3838
<h3 markdown="1">Inherited Methods</h3>
39-
<div style="line-height: 1;">
40-
<h4 markdown="1"><b>public ``string`` ToString();</b></h4>
41-
<h5 markdown="1">Inherited from: ``object``</h5>
42-
</div>
43-
<br>
4439
<div style="line-height: 1;">
4540
<h4 markdown="1"><b>public ``bool`` Equals(``object`` obj);</b></h4>
4641
<h5 markdown="1">Inherited from: ``object``</h5>
@@ -59,5 +54,10 @@ permalink: /api/bit-stream-pool/
5954
<h4 markdown="1"><b>public ``Type`` GetType();</b></h4>
6055
<h5 markdown="1">Inherited from: ``object``</h5>
6156
</div>
57+
<br>
58+
<div style="line-height: 1;">
59+
<h4 markdown="1"><b>public ``string`` ToString();</b></h4>
60+
<h5 markdown="1">Inherited from: ``object``</h5>
61+
</div>
6262
</div>
6363
<br>

0 commit comments

Comments
 (0)