-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
typed_data.dart
2596 lines (2395 loc) · 87.4 KB
/
typed_data.dart
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
// Copyright (c) 2013, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
/// Lists that efficiently handle fixed sized data
/// (for example, unsigned 8 byte integers) and SIMD numeric types.
///
/// To use this library in your code:
///
/// import 'dart:typed_data';
///
/// {@category Core}
library dart.typed_data;
import "dart:_internal" show UnmodifiableListBase;
part "unmodifiable_typed_data.dart";
/**
* A sequence of bytes underlying a typed data object.
*
* Used to process large quantities of binary or numerical data
* more efficiently using a typed view.
*/
abstract class ByteBuffer {
/**
* Returns the length of this byte buffer, in bytes.
*/
int get lengthInBytes;
/**
* Creates a [Uint8List] _view_ of a region of this byte buffer.
*
* The view is backed by the bytes of this byte buffer.
* Any changes made to the `Uint8List` will also change the buffer,
* and vice versa.
*
* The viewed region start at [offsetInBytes] and contains [length] bytes.
* If [length] is omitted, the range extends to the end of the buffer.
*
* The start index and length must describe a valid range of the buffer:
*
* * `offsetInBytes` must not be negative,
* * `length` must not be negative, and
* * `offsetInBytes + length` must not be greater than [lengthInBytes].
*/
Uint8List asUint8List([int offsetInBytes = 0, int length]);
/**
* Creates a [Int8List] _view_ of a region of this byte buffer.
*
* The view is backed by the bytes of this byte buffer.
* Any changes made to the `Int8List` will also change the buffer,
* and vice versa.
*
* The viewed region start at [offsetInBytes] and contains [length] bytes.
* If [length] is omitted, the range extends to the end of the buffer.
*
* The start index and length must describe a valid range of the buffer:
*
* * `offsetInBytes` must not be negative,
* * `length` must not be negative, and
* * `offsetInBytes + length` must not be greater than [lengthInBytes].
*/
Int8List asInt8List([int offsetInBytes = 0, int length]);
/**
* Creates a [Uint8ClampedList] _view_ of a region of this byte buffer.
*
* The view is backed by the bytes of this byte buffer.
* Any changes made to the `Uint8ClampedList` will also change the buffer,
* and vice versa.
*
* The viewed region start at [offsetInBytes] and contains [length] bytes.
* If [length] is omitted, the range extends to the end of the buffer.
*
* The start index and length must describe a valid range of the buffer:
*
* * `offsetInBytes` must not be negative,
* * `length` must not be negative, and
* * `offsetInBytes + length` must not be greater than [lengthInBytes].
*/
Uint8ClampedList asUint8ClampedList([int offsetInBytes = 0, int length]);
/**
* Creates a [Uint16List] _view_ of a region of this byte buffer.
*
* The view is backed by the bytes of this byte buffer.
* Any changes made to the `Uint16List` will also change the buffer,
* and vice versa.
*
* The viewed region start at [offsetInBytes], which must be 16-bit aligned,
* and contains [length] 16-bit integers.
* If [length] is omitted, the range extends as far towards the end of
* the buffer as possible -
* if [lengthInBytes] is not even, the last byte can't be part of the view.
*
* The start index and length must describe a valid 16-bit aligned range
* of the buffer:
*
* * `offsetInBytes` must not be negative,
* * `offsetInBytes` must be divisible by two,
* * `length` must not be negative, and
* * `offsetInBytes + length * 2` must not be greater than [lengthInBytes].
*/
Uint16List asUint16List([int offsetInBytes = 0, int length]);
/**
* Creates a [Int16List] _view_ of a region of this byte buffer.
*
* The view is backed by the bytes of this byte buffer.
* Any changes made to the `Int16List` will also change the buffer,
* and vice versa.
*
* The viewed region start at [offsetInBytes], which must be 16-bit aligned,
* and contains [length] 16-bit integers.
* If [length] is omitted, the range extends as far towards the end of
* the buffer as possible -
* if [lengthInBytes] is not even, the last byte can't be part of the view.
*
* The start index and length must describe a valid 16-bit aligned range
* of the buffer:
*
* * `offsetInBytes` must not be negative,
* * `offsetInBytes` must be divisible by two,
* * `length` must not be negative, and
* * `offsetInBytes + length * 2` must not be greater than [lengthInBytes].
*/
Int16List asInt16List([int offsetInBytes = 0, int length]);
/**
* Creates a [Uint32List] _view_ of a region of this byte buffer.
*
* The view is backed by the bytes of this byte buffer.
* Any changes made to the `Uint32List` will also change the buffer,
* and vice versa.
*
* The viewed region start at [offsetInBytes], which must be 32-bit aligned,
* and contains [length] 32-bit integers.
* If [length] is omitted, the range extends as far towards the end of
* the buffer as possible -
* if [lengthInBytes] is not divisible by four, the last bytes can't be part
* of the view.
*
* The start index and length must describe a valid 32-bit aligned range
* of the buffer:
*
* * `offsetInBytes` must not be negative,
* * `offsetInBytes` must be divisible by four,
* * `length` must not be negative, and
* * `offsetInBytes + length * 4` must not be greater than [lengthInBytes].
*/
Uint32List asUint32List([int offsetInBytes = 0, int length]);
/**
* Creates a [Int32List] _view_ of a region of this byte buffer.
*
* The view is backed by the bytes of this byte buffer.
* Any changes made to the `Int32List` will also change the buffer,
* and vice versa.
*
* The viewed region start at [offsetInBytes], which must be 32-bit aligned,
* and contains [length] 32-bit integers.
* If [length] is omitted, the range extends as far towards the end of
* the buffer as possible -
* if [lengthInBytes] is not divisible by four, the last bytes can't be part
* of the view.
*
* The start index and length must describe a valid 32-bit aligned range
* of the buffer:
*
* * `offsetInBytes` must not be negative,
* * `offsetInBytes` must be divisible by four,
* * `length` must not be negative, and
* * `offsetInBytes + length * 4` must not be greater than [lengthInBytes].
*/
Int32List asInt32List([int offsetInBytes = 0, int length]);
/**
* Creates a [Uint64List] _view_ of a region of this byte buffer.
*
* The view is backed by the bytes of this byte buffer.
* Any changes made to the `Uint64List` will also change the buffer,
* and vice versa.
*
* The viewed region start at [offsetInBytes], which must be 64-bit aligned,
* and contains [length] 64-bit integers.
* If [length] is omitted, the range extends as far towards the end of
* the buffer as possible -
* if [lengthInBytes] is not divisible by eight, the last bytes can't be part
* of the view.
*
* The start index and length must describe a valid 64-bit aligned range
* of the buffer:
*
* * `offsetInBytes` must not be negative,
* * `offsetInBytes` must be divisible by eight,
* * `length` must not be negative, and
* * `offsetInBytes + length * 8` must not be greater than [lengthInBytes].
*/
Uint64List asUint64List([int offsetInBytes = 0, int length]);
/**
* Creates a [Int64List] _view_ of a region of this byte buffer.
*
* The view is backed by the bytes of this byte buffer.
* Any changes made to the `Int64List` will also change the buffer,
* and vice versa.
*
* The viewed region start at [offsetInBytes], which must be 64-bit aligned,
* and contains [length] 64-bit integers.
* If [length] is omitted, the range extends as far towards the end of
* the buffer as possible -
* if [lengthInBytes] is not divisible by eight, the last bytes can't be part
* of the view.
*
* The start index and length must describe a valid 64-bit aligned range
* of the buffer:
*
* * `offsetInBytes` must not be negative,
* * `offsetInBytes` must be divisible by eight,
* * `length` must not be negative, and
* * `offsetInBytes + length * 8` must not be greater than [lengthInBytes].
*/
Int64List asInt64List([int offsetInBytes = 0, int length]);
/**
* Creates a [Int32x4List] _view_ of a region of this byte buffer.
*
* The view is backed by the bytes of this byte buffer.
* Any changes made to the `Int32x4List` will also change the buffer,
* and vice versa.
*
* The viewed region start at [offsetInBytes], which must be 128-bit aligned,
* and contains [length] 128-bit integers.
* If [length] is omitted, the range extends as far towards the end of
* the buffer as possible -
* if [lengthInBytes] is not divisible by 16, the last bytes can't be part
* of the view.
*
* The start index and length must describe a valid 128-bit aligned range
* of the buffer:
*
* * `offsetInBytes` must not be negative,
* * `offsetInBytes` must be divisible by sixteen,
* * `length` must not be negative, and
* * `offsetInBytes + length * 16` must not be greater than [lengthInBytes].
*/
Int32x4List asInt32x4List([int offsetInBytes = 0, int length]);
/**
* Creates a [Float32List] _view_ of a region of this byte buffer.
*
* The view is backed by the bytes of this byte buffer.
* Any changes made to the `Float32List` will also change the buffer,
* and vice versa.
*
* The viewed region start at [offsetInBytes], which must be 32-bit aligned,
* and contains [length] 32-bit integers.
* If [length] is omitted, the range extends as far towards the end of
* the buffer as possible -
* if [lengthInBytes] is not divisible by four, the last bytes can't be part
* of the view.
*
* The start index and length must describe a valid 32-bit aligned range
* of the buffer:
*
* * `offsetInBytes` must not be negative,
* * `offsetInBytes` must be divisible by four,
* * `length` must not be negative, and
* * `offsetInBytes + length * 4` must not be greater than [lengthInBytes].
*/
Float32List asFloat32List([int offsetInBytes = 0, int length]);
/**
* Creates a [Float64List] _view_ of a region of this byte buffer.
*
* The view is backed by the bytes of this byte buffer.
* Any changes made to the `Float64List` will also change the buffer,
* and vice versa.
*
* The viewed region start at [offsetInBytes], which must be 64-bit aligned,
* and contains [length] 64-bit integers.
* If [length] is omitted, the range extends as far towards the end of
* the buffer as possible -
* if [lengthInBytes] is not divisible by eight, the last bytes can't be part
* of the view.
*
* The start index and length must describe a valid 64-bit aligned range
* of the buffer:
*
* * `offsetInBytes` must not be negative,
* * `offsetInBytes` must be divisible by eight,
* * `length` must not be negative, and
* * `offsetInBytes + length * 8` must not be greater than [lengthInBytes].
*/
Float64List asFloat64List([int offsetInBytes = 0, int length]);
/**
* Creates a [Float32x4List] _view_ of a region of this byte buffer.
*
* The view is backed by the bytes of this byte buffer.
* Any changes made to the `Float32x4List` will also change the buffer,
* and vice versa.
*
* The viewed region start at [offsetInBytes], which must be 128-bit aligned,
* and contains [length] 128-bit integers.
* If [length] is omitted, the range extends as far towards the end of
* the buffer as possible -
* if [lengthInBytes] is not divisible by 16, the last bytes can't be part
* of the view.
*
* The start index and length must describe a valid 128-bit aligned range
* of the buffer:
*
* * `offsetInBytes` must not be negative,
* * `offsetInBytes` must be divisible by sixteen,
* * `length` must not be negative, and
* * `offsetInBytes + length * 16` must not be greater than [lengthInBytes].
*/
Float32x4List asFloat32x4List([int offsetInBytes = 0, int length]);
/**
* Creates a [Float64x2List] _view_ of a region of this byte buffer.
*
* The view is backed by the bytes of this byte buffer.
* Any changes made to the `Float64x2List` will also change the buffer,
* and vice versa.
*
* The viewed region start at [offsetInBytes], which must be 128-bit aligned,
* and contains [length] 128-bit integers.
* If [length] is omitted, the range extends as far towards the end of
* the buffer as possible -
* if [lengthInBytes] is not divisible by 16, the last bytes can't be part
* of the view.
*
* The start index and length must describe a valid 128-bit aligned range
* of the buffer:
*
* * `offsetInBytes` must not be negative,
* * `offsetInBytes` must be divisible by sixteen,
* * `length` must not be negative, and
* * `offsetInBytes + length * 16` must not be greater than [lengthInBytes].
*/
Float64x2List asFloat64x2List([int offsetInBytes = 0, int length]);
/**
* Creates a [ByteData] _view_ of a region of this byte buffer.
*
* The view is backed by the bytes of this byte buffer.
* Any changes made to the `ByteData` will also change the buffer,
* and vice versa.
*
* The viewed region start at [offsetInBytes] and contains [length] bytes.
* If [length] is omitted, the range extends to the end of the buffer.
*
* The start index and length must describe a valid range of the buffer:
*
* * `offsetInBytes` must not be negative,
* * `length` must not be negative, and
* * `offsetInBytes + length` must not be greater than [lengthInBytes].
*/
ByteData asByteData([int offsetInBytes = 0, int length]);
}
/**
* A typed view of a sequence of bytes.
*/
abstract class TypedData {
/**
* Returns the number of bytes in the representation of each element in this
* list.
*/
int get elementSizeInBytes;
/**
* Returns the offset in bytes into the underlying byte buffer of this view.
*/
int get offsetInBytes;
/**
* Returns the length of this view, in bytes.
*/
int get lengthInBytes;
/**
* Returns the byte buffer associated with this object.
*/
ByteBuffer get buffer;
}
abstract class _TypedIntList extends TypedData {
/**
* Returns the concatenation of this list and [other].
*
* If other is also a typed-data integer list, the returned list will
* be a type-data integer list capable of containing all the elements of
* this list and of [other].
* Otherwise the returned list will be a normal growable `List<int>`.
*/
List<int> operator +(List<int> other);
}
abstract class _TypedFloatList extends TypedData {
/**
* Returns the concatenation of this list and [other].
*
* If other is also a typed-data floating point number list,
* the returned list will be a type-data float list capable of containing
* all the elements of this list and of [other].
* Otherwise the returned list will be a normal growable `List<double>`.
*/
List<double> operator +(List<double> other);
}
/**
* Describes endianness to be used when accessing or updating a
* sequence of bytes.
*/
class Endian {
final bool _littleEndian;
const Endian._(this._littleEndian);
static const Endian big = const Endian._(false);
static const Endian little = const Endian._(true);
static final Endian host =
(new ByteData.view(new Uint16List.fromList([1]).buffer)).getInt8(0) == 1
? little
: big;
}
/**
* A fixed-length, random-access sequence of bytes that also provides random
* and unaligned access to the fixed-width integers and floating point
* numbers represented by those bytes.
*
* `ByteData` may be used to pack and unpack data from external sources
* (such as networks or files systems), and to process large quantities
* of numerical data more efficiently than would be possible
* with ordinary [List] implementations.
* `ByteData` can save space, by eliminating the need for object headers,
* and time, by eliminating the need for data copies.
* Finally, `ByteData` may be used to intentionally reinterpret the bytes
* representing one arithmetic type as another.
* For example this code fragment determine what 32-bit signed integer
* is represented by the bytes of a 32-bit floating point number:
*
* var buffer = new Uint8List(8).buffer;
* var bdata = new ByteData.view(buffer);
* bdata.setFloat32(0, 3.04);
* int huh = bdata.getInt32(0);
*/
abstract class ByteData implements TypedData {
/**
* Creates a [ByteData] of the specified length (in elements), all of
* whose bytes are initially zero.
*/
@pragma("vm:entry-point")
external factory ByteData(int length);
/**
* Creates an [ByteData] _view_ of the specified region in [buffer].
*
* Changes in the [ByteData] will be visible in the byte
* buffer and vice versa.
* If the [offsetInBytes] index of the region is not specified,
* it defaults to zero (the first byte in the byte buffer).
* If the length is not specified, it defaults to `null`,
* which indicates that the view extends to the end of the byte buffer.
*
* Throws [RangeError] if [offsetInBytes] or [length] are negative, or
* if [offsetInBytes] + ([length] * elementSizeInBytes) is greater than
* the length of [buffer].
*/
factory ByteData.view(ByteBuffer buffer,
[int offsetInBytes = 0, int length]) {
return buffer.asByteData(offsetInBytes, length);
}
/**
* Returns the (possibly negative) integer represented by the byte at the
* specified [byteOffset] in this object, in two's complement binary
* representation.
*
* The return value will be between -128 and 127, inclusive.
*
* Throws [RangeError] if [byteOffset] is negative, or
* greater than or equal to the length of this object.
*/
int getInt8(int byteOffset);
/**
* Sets the byte at the specified [byteOffset] in this object to the
* two's complement binary representation of the specified [value], which
* must fit in a single byte.
*
* In other words, [value] must be between -128 and 127, inclusive.
*
* Throws [RangeError] if [byteOffset] is negative, or
* greater than or equal to the length of this object.
*/
void setInt8(int byteOffset, int value);
/**
* Returns the positive integer represented by the byte at the specified
* [byteOffset] in this object, in unsigned binary form.
*
* The return value will be between 0 and 255, inclusive.
*
* Throws [RangeError] if [byteOffset] is negative, or
* greater than or equal to the length of this object.
*/
int getUint8(int byteOffset);
/**
* Sets the byte at the specified [byteOffset] in this object to the
* unsigned binary representation of the specified [value], which must fit
* in a single byte.
*
* In other words, [value] must be between 0 and 255, inclusive.
*
* Throws [RangeError] if [byteOffset] is negative,
* or greater than or equal to the length of this object.
*/
void setUint8(int byteOffset, int value);
/**
* Returns the (possibly negative) integer represented by the two bytes at
* the specified [byteOffset] in this object, in two's complement binary
* form.
*
* The return value will be between -2<sup>15</sup> and 2<sup>15</sup> - 1,
* inclusive.
*
* Throws [RangeError] if [byteOffset] is negative, or
* `byteOffset + 2` is greater than the length of this object.
*/
int getInt16(int byteOffset, [Endian endian = Endian.big]);
/**
* Sets the two bytes starting at the specified [byteOffset] in this
* object to the two's complement binary representation of the specified
* [value], which must fit in two bytes.
*
* In other words, [value] must lie
* between -2<sup>15</sup> and 2<sup>15</sup> - 1, inclusive.
*
* Throws [RangeError] if [byteOffset] is negative, or
* `byteOffset + 2` is greater than the length of this object.
*/
void setInt16(int byteOffset, int value, [Endian endian = Endian.big]);
/**
* Returns the positive integer represented by the two bytes starting
* at the specified [byteOffset] in this object, in unsigned binary
* form.
*
* The return value will be between 0 and 2<sup>16</sup> - 1, inclusive.
*
* Throws [RangeError] if [byteOffset] is negative, or
* `byteOffset + 2` is greater than the length of this object.
*/
int getUint16(int byteOffset, [Endian endian = Endian.big]);
/**
* Sets the two bytes starting at the specified [byteOffset] in this object
* to the unsigned binary representation of the specified [value],
* which must fit in two bytes.
*
* In other words, [value] must be between
* 0 and 2<sup>16</sup> - 1, inclusive.
*
* Throws [RangeError] if [byteOffset] is negative, or
* `byteOffset + 2` is greater than the length of this object.
*/
void setUint16(int byteOffset, int value, [Endian endian = Endian.big]);
/**
* Returns the (possibly negative) integer represented by the four bytes at
* the specified [byteOffset] in this object, in two's complement binary
* form.
*
* The return value will be between -2<sup>31</sup> and 2<sup>31</sup> - 1,
* inclusive.
*
* Throws [RangeError] if [byteOffset] is negative, or
* `byteOffset + 4` is greater than the length of this object.
*/
int getInt32(int byteOffset, [Endian endian = Endian.big]);
/**
* Sets the four bytes starting at the specified [byteOffset] in this
* object to the two's complement binary representation of the specified
* [value], which must fit in four bytes.
*
* In other words, [value] must lie
* between -2<sup>31</sup> and 2<sup>31</sup> - 1, inclusive.
*
* Throws [RangeError] if [byteOffset] is negative, or
* `byteOffset + 4` is greater than the length of this object.
*/
void setInt32(int byteOffset, int value, [Endian endian = Endian.big]);
/**
* Returns the positive integer represented by the four bytes starting
* at the specified [byteOffset] in this object, in unsigned binary
* form.
*
* The return value will be between 0 and 2<sup>32</sup> - 1, inclusive.
*
* Throws [RangeError] if [byteOffset] is negative, or
* `byteOffset + 4` is greater than the length of this object.
*/
int getUint32(int byteOffset, [Endian endian = Endian.big]);
/**
* Sets the four bytes starting at the specified [byteOffset] in this object
* to the unsigned binary representation of the specified [value],
* which must fit in four bytes.
*
* In other words, [value] must be between
* 0 and 2<sup>32</sup> - 1, inclusive.
*
* Throws [RangeError] if [byteOffset] is negative, or
* `byteOffset + 4` is greater than the length of this object.
*/
void setUint32(int byteOffset, int value, [Endian endian = Endian.big]);
/**
* Returns the (possibly negative) integer represented by the eight bytes at
* the specified [byteOffset] in this object, in two's complement binary
* form.
*
* The return value will be between -2<sup>63</sup> and 2<sup>63</sup> - 1,
* inclusive.
*
* Throws [RangeError] if [byteOffset] is negative, or
* `byteOffset + 8` is greater than the length of this object.
*/
int getInt64(int byteOffset, [Endian endian = Endian.big]);
/**
* Sets the eight bytes starting at the specified [byteOffset] in this
* object to the two's complement binary representation of the specified
* [value], which must fit in eight bytes.
*
* In other words, [value] must lie
* between -2<sup>63</sup> and 2<sup>63</sup> - 1, inclusive.
*
* Throws [RangeError] if [byteOffset] is negative, or
* `byteOffset + 8` is greater than the length of this object.
*/
void setInt64(int byteOffset, int value, [Endian endian = Endian.big]);
/**
* Returns the positive integer represented by the eight bytes starting
* at the specified [byteOffset] in this object, in unsigned binary
* form.
*
* The return value will be between 0 and 2<sup>64</sup> - 1, inclusive.
*
* Throws [RangeError] if [byteOffset] is negative, or
* `byteOffset + 8` is greater than the length of this object.
*/
int getUint64(int byteOffset, [Endian endian = Endian.big]);
/**
* Sets the eight bytes starting at the specified [byteOffset] in this object
* to the unsigned binary representation of the specified [value],
* which must fit in eight bytes.
*
* In other words, [value] must be between
* 0 and 2<sup>64</sup> - 1, inclusive.
*
* Throws [RangeError] if [byteOffset] is negative, or
* `byteOffset + 8` is greater than the length of this object.
*/
void setUint64(int byteOffset, int value, [Endian endian = Endian.big]);
/**
* Returns the floating point number represented by the four bytes at
* the specified [byteOffset] in this object, in IEEE 754
* single-precision binary floating-point format (binary32).
*
* Throws [RangeError] if [byteOffset] is negative, or
* `byteOffset + 4` is greater than the length of this object.
*/
double getFloat32(int byteOffset, [Endian endian = Endian.big]);
/**
* Sets the four bytes starting at the specified [byteOffset] in this
* object to the IEEE 754 single-precision binary floating-point
* (binary32) representation of the specified [value].
*
* **Note that this method can lose precision.** The input [value] is
* a 64-bit floating point value, which will be converted to 32-bit
* floating point value by IEEE 754 rounding rules before it is stored.
* If [value] cannot be represented exactly as a binary32, it will be
* converted to the nearest binary32 value. If two binary32 values are
* equally close, the one whose least significant bit is zero will be used.
* Note that finite (but large) values can be converted to infinity, and
* small non-zero values can be converted to zero.
*
* Throws [RangeError] if [byteOffset] is negative, or
* `byteOffset + 4` is greater than the length of this object.
*/
void setFloat32(int byteOffset, double value, [Endian endian = Endian.big]);
/**
* Returns the floating point number represented by the eight bytes at
* the specified [byteOffset] in this object, in IEEE 754
* double-precision binary floating-point format (binary64).
*
* Throws [RangeError] if [byteOffset] is negative, or
* `byteOffset + 8` is greater than the length of this object.
*/
double getFloat64(int byteOffset, [Endian endian = Endian.big]);
/**
* Sets the eight bytes starting at the specified [byteOffset] in this
* object to the IEEE 754 double-precision binary floating-point
* (binary64) representation of the specified [value].
*
* Throws [RangeError] if [byteOffset] is negative, or
* `byteOffset + 8` is greater than the length of this object.
*/
void setFloat64(int byteOffset, double value, [Endian endian = Endian.big]);
}
/**
* A fixed-length list of 8-bit signed integers.
*
* For long lists, this implementation can be considerably
* more space- and time-efficient than the default [List] implementation.
*
* Integers stored in the list are truncated to their low eight bits,
* interpreted as a signed 8-bit two's complement integer with values in the
* range -128 to +127.
*/
abstract class Int8List implements List<int>, _TypedIntList {
/**
* Creates an [Int8List] of the specified length (in elements), all of
* whose elements are initially zero.
*/
external factory Int8List(int length);
/**
* Creates a [Int8List] with the same length as the [elements] list
* and copies over the elements.
*
* Values are truncated to fit in the list when they are copied,
* the same way storing values truncates them.
*/
external factory Int8List.fromList(List<int> elements);
/**
* Creates an [Int8List] _view_ of the specified region in [buffer].
*
* Changes in the [Int8List] will be visible in the byte
* buffer and vice versa.
* If the [offsetInBytes] index of the region is not specified,
* it defaults to zero (the first byte in the byte buffer).
* If the length is not specified, it defaults to `null`,
* which indicates that the view extends to the end of the byte buffer.
*
* Throws [RangeError] if [offsetInBytes] or [length] are negative, or
* if [offsetInBytes] + ([length] * elementSizeInBytes) is greater than
* the length of [buffer].
*/
factory Int8List.view(ByteBuffer buffer,
[int offsetInBytes = 0, int length]) {
return buffer.asInt8List(offsetInBytes, length);
}
/**
* Returns a new list containing the elements between [start] and [end].
*
* The new list is an `Int8List` containing the elements of this list at
* positions greater than or equal to [start] and less than [end] in the same
* order as they occur in this list.
*
* ```dart
* var numbers = Int8List.fromList([0, 1, 2, 3, 4]);
* print(numbers.sublist(1, 3)); // [1, 2]
* print(numbers.sublist(1, 3).runtimeType); // Int8List
* ```
*
* If [end] is omitted, it defaults to the [length] of this list.
*
* ```dart
* print(numbers.sublist(1)); // [1, 2, 3, 4]
* ```
*
* The `start` and `end` positions must satisfy the relations
* 0 ≤ `start` ≤ `end` ≤ `this.length`
* If `end` is equal to `start`, then the returned list is empty.
*/
Int8List sublist(int start, [int end]);
static const int bytesPerElement = 1;
}
/**
* A fixed-length list of 8-bit unsigned integers.
*
* For long lists, this implementation can be considerably
* more space- and time-efficient than the default [List] implementation.
*
* Integers stored in the list are truncated to their low eight bits,
* interpreted as an unsigned 8-bit integer with values in the
* range 0 to 255.
*/
abstract class Uint8List implements List<int>, _TypedIntList {
/**
* Creates a [Uint8List] of the specified length (in elements), all of
* whose elements are initially zero.
*/
external factory Uint8List(int length);
/**
* Creates a [Uint8List] with the same length as the [elements] list
* and copies over the elements.
*
* Values are truncated to fit in the list when they are copied,
* the same way storing values truncates them.
*/
external factory Uint8List.fromList(List<int> elements);
/**
* Creates a [Uint8List] _view_ of the specified region in [buffer].
*
* Changes in the [Uint8List] will be visible in the byte
* buffer and vice versa.
* If the [offsetInBytes] index of the region is not specified,
* it defaults to zero (the first byte in the byte buffer).
* If the length is not specified, it defaults to `null`,
* which indicates that the view extends to the end of the byte buffer.
*
* Throws [RangeError] if [offsetInBytes] or [length] are negative, or
* if [offsetInBytes] + ([length] * elementSizeInBytes) is greater than
* the length of [buffer].
*/
factory Uint8List.view(ByteBuffer buffer,
[int offsetInBytes = 0, int length]) {
return buffer.asUint8List(offsetInBytes, length);
}
/**
* Returns a concatenation of this list and [other].
*
* If [other] is also a typed-data list, then the return list will be a
* typed data list capable of holding both unsigned 8-bit integers and
* the elements of [other], otherwise it'll be a normal list of integers.
*/
List<int> operator +(List<int> other);
/**
* Returns a new list containing the elements between [start] and [end].
*
* The new list is a `Uint8List` containing the elements of this list at
* positions greater than or equal to [start] and less than [end] in the same
* order as they occur in this list.
*
* ```dart
* var numbers = Uint8List.fromList([0, 1, 2, 3, 4]);
* print(numbers.sublist(1, 3)); // [1, 2]
* print(numbers.sublist(1, 3).runtimeType); // Uint8List
* ```
*
* If [end] is omitted, it defaults to the [length] of this list.
*
* ```dart
* print(numbers.sublist(1)); // [1, 2, 3, 4]
* ```
*
* The `start` and `end` positions must satisfy the relations
* 0 ≤ `start` ≤ `end` ≤ `this.length`
* If `end` is equal to `start`, then the returned list is empty.
*/
Uint8List sublist(int start, [int end]);
static const int bytesPerElement = 1;
}
/**
* A fixed-length list of 8-bit unsigned integers.
*
* For long lists, this implementation can be considerably
* more space- and time-efficient than the default [List] implementation.
*
* Integers stored in the list are clamped to an unsigned eight bit value.
* That is, all values below zero are stored as zero
* and all values above 255 are stored as 255.
*/
abstract class Uint8ClampedList implements List<int>, _TypedIntList {
/**
* Creates a [Uint8ClampedList] of the specified length (in elements), all of
* whose elements are initially zero.
*/
external factory Uint8ClampedList(int length);
/**
* Creates a [Uint8ClampedList] of the same size as the [elements]
* list and copies over the values clamping when needed.
*
* Values are clamped to fit in the list when they are copied,
* the same way storing values clamps them.
*/
external factory Uint8ClampedList.fromList(List<int> elements);
/**
* Creates a [Uint8ClampedList] _view_ of the specified region in the
* specified byte [buffer].
*
* Changes in the [Uint8List] will be visible in the byte buffer
* and vice versa.
* If the [offsetInBytes] index of the region is not specified,
* it defaults to zero (the first byte in the byte buffer).
* If the length is not specified, it defaults to `null`,
* which indicates that the view extends to the end of the byte buffer.
*
* Throws [RangeError] if [offsetInBytes] or [length] are negative, or
* if [offsetInBytes] + ([length] * elementSizeInBytes) is greater than
* the length of [buffer].
*/
factory Uint8ClampedList.view(ByteBuffer buffer,
[int offsetInBytes = 0, int length]) {
return buffer.asUint8ClampedList(offsetInBytes, length);
}
/**
* Returns a new list containing the elements between [start] and [end].
*
* The new list is a `Uint8ClampedList` containing the elements of this
* list at positions greater than or equal to [start] and less than [end] in
* the same order as they occur in this list.
*
* ```dart
* var numbers = Uint8ClampedList.fromList([0, 1, 2, 3, 4]);
* print(numbers.sublist(1, 3)); // [1, 2]
* print(numbers.sublist(1, 3).runtimeType); // Uint8ClampedList
* ```
*
* If [end] is omitted, it defaults to the [length] of this list.
*
* ```dart
* print(numbers.sublist(1)); // [1, 2, 3, 4]
* ```
*
* The `start` and `end` positions must satisfy the relations
* 0 ≤ `start` ≤ `end` ≤ `this.length`
* If `end` is equal to `start`, then the returned list is empty.
*/
Uint8ClampedList sublist(int start, [int end]);
static const int bytesPerElement = 1;
}
/**
* A fixed-length list of 16-bit signed integers that is viewable as a
* [TypedData].
*
* For long lists, this implementation can be considerably
* more space- and time-efficient than the default [List] implementation.
*
* Integers stored in the list are truncated to their low 16 bits,
* interpreted as a signed 16-bit two's complement integer with values in the
* range -32768 to +32767.
*/
abstract class Int16List implements List<int>, _TypedIntList {
/**
* Creates an [Int16List] of the specified length (in elements), all of
* whose elements are initially zero.
*/
external factory Int16List(int length);
/**
* Creates a [Int16List] with the same length as the [elements] list
* and copies over the elements.
*
* Values are truncated to fit in the list when they are copied,
* the same way storing values truncates them.
*/
external factory Int16List.fromList(List<int> elements);
/**
* Creates an [Int16List] _view_ of the specified region in [buffer].
*
* Changes in the [Int16List] will be visible in the byte
* buffer and vice versa.
* If the [offsetInBytes] index of the region is not specified,
* it defaults to zero (the first byte in the byte buffer).
* If the length is not specified, it defaults to `null`,
* which indicates that the view extends to the end of the byte buffer.
*
* Throws [RangeError] if [offsetInBytes] or [length] are negative, or
* if [offsetInBytes] + ([length] * elementSizeInBytes) is greater than
* the length of [buffer].
*
* Throws [ArgumentError] if [offsetInBytes] is not a multiple of