bytepack 0.3.0

bytepack offers a Read and Write trait extension generalized for any packed data type.
Documentation
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
//! `bytepack` is a simple crate which extends the `std::io` API to be able to read and write any 
//! data type in their memory representation. It can be seen as a generalization of the 
//! `std::io::Read` and `std::io::Write` trait , but operating on a generic parameter `T` instead 
//! of `u8`. This crate focus on performances by beeing no copy (except in one clearly marked case) 
//! and offering methods to read and write arrays.
//! 
//! `bytepack` offers three trait famillies allowing different endianness control. 
//! [`Unpacker`](trait.Unpacked.html) and [`Packer`](trait.Packer.html) read and write data in the 
//! endianness of the operating system. [`LEUnpacker`](trait.LEUnpacker.html) and 
//! [`LEPacker`](trait.LEPacker.html) always read and write data in little endian while 
//! [`BEUnpacker`](trait.BEUnpacker.html) and [`BEPacker`](trait.BEPacker.html) do the 
//! same in big endian. They all conform to the same API which is copied from the one of `std::io`.
//! This means switching from one endianness to another can be done by simply bringing a different 
//! trait in scope.
//!
//! Because `bytepack` is not a serialization library, it cannot read and write complex types like 
//! `Vec`, `Rc`, etc. directly from a Reader or to Writer. Indeed those types do not contain the 
//! underlying data directly packed inside but rather hold a reference or a pointer to it. To 
//! identify types which holds their data "packed" together, the [`Packed`](trait.Packed.html) 
//! trait is used. Additionnaly it provides a in-place endianness switching method. One can 
//! implement this trait for the data types deemed safe to read and write. A custom derive for 
//! structures made only of types implementing [`Packed`](trait.Packed.html) also exists.
//!
//! # Example
//!
//! ```no_run
//! use std::fs::File;
//! use std::iter::repeat;
//!
//! use bytepack::{LEPacker, LEUnpacker};
//!
//! fn write_samples(file: &str, samples: &Vec<f32>) {
//!     let mut file = File::create(file).unwrap();
//!     file.pack(samples.len() as u32).unwrap();
//!     file.pack_all(&samples[..]).unwrap();
//! }
//!
//! fn read_samples(file: &str) -> Vec<f32> {
//!     let mut file = File::open(file).unwrap();
//!     let num_samples : u32 = file.unpack().unwrap();
//!     let mut samples : Vec<f32> = repeat(0f32).take(num_samples as usize).collect();
//!     file.unpack_exact(&mut samples[..]).unwrap();
//!     return samples;
//! }
//! ```

use std::io::{Read, Write, Result, Error, ErrorKind};
use std::mem::{zeroed, transmute, size_of, forget};
use std::slice;

/// This trait both identifies a type which holds his data packed together in memory and a type 
/// which offers a `switch_endianness` method. This trait is voluntarily not implemented for 
/// `isize` and `usize` because their size can vary from one system to another.
///
/// # Example
///
/// If you would like to read and write one of your struct using `bytepack`, you can derive 
/// `Packed` for it:
///
/// ```no_run
/// extern crate bytepack;
/// #[macro_use]
/// extern crate bytepack_derive;
/// 
/// use std::fs::File;
/// use bytepack::{LEUnpacker, Packed};
///
/// #[derive(Packed)]
/// struct Vector {
///    x: f32,
///    y: f32,
///    z: f32,
/// }
///
/// #[derive(Packed)]
/// struct RGB(u8,u8,u8);
///
/// fn main() {
///     let mut file = File::open("test").unwrap();
///     let vector : Vector = file.unpack().unwrap();
///     let rgb : RGB = file.unpack().unwrap();
/// }
///
/// ```
///
/// Please note that also specifying `#[repr(packed)]` might make sense if you want to get rid of 
/// the padding inside your structure.
/// 
/// `Packed` can only be derived for strutures only composed of types implementing `Packed` 
/// themselves. If you which to circumvent this restriction you can implement `Packed` yourselve, 
/// however you need to make sure your struct is indeed "packed" and that reading and writing it as 
/// one continuous memory zone makes sense. For example the following structures are not "packed" 
/// because they all hold a reference to their data.
///
/// ```ignore
/// struct NotPacked1 {
///     name: String
/// }
///
/// struct NotPacked2 {
///     numbers: Vec<f32>
/// }
///
/// struct NotPacked3 {
///     count: Rc<u64>
/// }
/// ```
pub trait Packed {
    /// Perform an in-place switch of the endianness. This might be a no-op in some cases.
    fn switch_endianness(&mut self);
}

impl Packed for bool {
    fn switch_endianness(&mut self) {
    }
}

impl Packed for u8 {
    fn switch_endianness(&mut self) {
    }
}

impl Packed for i8 {
    fn switch_endianness(&mut self) {
    }
}

impl Packed for u16 {
    fn switch_endianness(&mut self) {
        *self = u16::swap_bytes(*self);
    }
}

impl Packed for i16 {
    fn switch_endianness(&mut self) {
        *self = i16::swap_bytes(*self);
    }
}

impl Packed for u32 {
    fn switch_endianness(&mut self) {
        *self = u32::swap_bytes(*self);
    }
}

impl Packed for i32 {
    fn switch_endianness(&mut self) {
        *self = i32::swap_bytes(*self);
    }
}

impl Packed for u64 {
    fn switch_endianness(&mut self) {
        *self = u64::swap_bytes(*self);
    }
}

impl Packed for i64 {
    fn switch_endianness(&mut self) {
        *self = i64::swap_bytes(*self);
    }
}

impl Packed for f32 {
    fn switch_endianness(&mut self) {
        // Safe because we always revert to the original type
        unsafe {
            *self = transmute(u32::swap_bytes(transmute(*self)));
        }
    }
}

impl Packed for f64 {
    fn switch_endianness(&mut self) {
        // Safe because we always revert to the original type
        unsafe {
            *self = transmute(u64::swap_bytes(transmute(*self)));
        }
    }
}

impl<T> Packed for [T;1] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
    }
}

impl<T> Packed for [T;2] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
    }
}

impl<T> Packed for [T;3] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
    }
}

impl<T> Packed for [T;4] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
    }
}

impl<T> Packed for [T;5] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
    }
}

impl<T> Packed for [T;6] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
    }
}

impl<T> Packed for [T;7] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
    }
}

impl<T> Packed for [T;8] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
    }
}

impl<T> Packed for [T;9] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
    }
}

impl<T> Packed for [T;10] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
    }
}

impl<T> Packed for [T;11] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
    }
}

impl<T> Packed for [T;12] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
        self[11].switch_endianness();
    }
}

impl<T> Packed for [T;13] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
        self[11].switch_endianness();
        self[12].switch_endianness();
    }
}

impl<T> Packed for [T;14] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
        self[11].switch_endianness();
        self[12].switch_endianness();
        self[13].switch_endianness();
    }
}

impl<T> Packed for [T;15] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
        self[11].switch_endianness();
        self[12].switch_endianness();
        self[13].switch_endianness();
        self[14].switch_endianness();
    }
}

impl<T> Packed for [T;16] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
        self[11].switch_endianness();
        self[12].switch_endianness();
        self[13].switch_endianness();
        self[14].switch_endianness();
        self[15].switch_endianness();
    }
}

impl<T> Packed for [T;17] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
        self[11].switch_endianness();
        self[12].switch_endianness();
        self[13].switch_endianness();
        self[14].switch_endianness();
        self[15].switch_endianness();
        self[16].switch_endianness();
    }
}

impl<T> Packed for [T;18] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
        self[11].switch_endianness();
        self[12].switch_endianness();
        self[13].switch_endianness();
        self[14].switch_endianness();
        self[15].switch_endianness();
        self[16].switch_endianness();
        self[17].switch_endianness();
    }
}

impl<T> Packed for [T;19] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
        self[11].switch_endianness();
        self[12].switch_endianness();
        self[13].switch_endianness();
        self[14].switch_endianness();
        self[15].switch_endianness();
        self[16].switch_endianness();
        self[17].switch_endianness();
        self[18].switch_endianness();
    }
}

impl<T> Packed for [T;20] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
        self[11].switch_endianness();
        self[12].switch_endianness();
        self[13].switch_endianness();
        self[14].switch_endianness();
        self[15].switch_endianness();
        self[16].switch_endianness();
        self[17].switch_endianness();
        self[18].switch_endianness();
        self[19].switch_endianness();
    }
}

impl<T> Packed for [T;21] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
        self[11].switch_endianness();
        self[12].switch_endianness();
        self[13].switch_endianness();
        self[14].switch_endianness();
        self[15].switch_endianness();
        self[16].switch_endianness();
        self[17].switch_endianness();
        self[18].switch_endianness();
        self[19].switch_endianness();
        self[20].switch_endianness();
    }
}

impl<T> Packed for [T;22] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
        self[11].switch_endianness();
        self[12].switch_endianness();
        self[13].switch_endianness();
        self[14].switch_endianness();
        self[15].switch_endianness();
        self[16].switch_endianness();
        self[17].switch_endianness();
        self[18].switch_endianness();
        self[19].switch_endianness();
        self[20].switch_endianness();
        self[21].switch_endianness();
    }
}

impl<T> Packed for [T;23] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
        self[11].switch_endianness();
        self[12].switch_endianness();
        self[13].switch_endianness();
        self[14].switch_endianness();
        self[15].switch_endianness();
        self[16].switch_endianness();
        self[17].switch_endianness();
        self[18].switch_endianness();
        self[19].switch_endianness();
        self[20].switch_endianness();
        self[21].switch_endianness();
        self[22].switch_endianness();
    }
}

impl<T> Packed for [T;24] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
        self[11].switch_endianness();
        self[12].switch_endianness();
        self[13].switch_endianness();
        self[14].switch_endianness();
        self[15].switch_endianness();
        self[16].switch_endianness();
        self[17].switch_endianness();
        self[18].switch_endianness();
        self[19].switch_endianness();
        self[20].switch_endianness();
        self[21].switch_endianness();
        self[22].switch_endianness();
        self[23].switch_endianness();
    }
}

impl<T> Packed for [T;25] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
        self[11].switch_endianness();
        self[12].switch_endianness();
        self[13].switch_endianness();
        self[14].switch_endianness();
        self[15].switch_endianness();
        self[16].switch_endianness();
        self[17].switch_endianness();
        self[18].switch_endianness();
        self[19].switch_endianness();
        self[20].switch_endianness();
        self[21].switch_endianness();
        self[22].switch_endianness();
        self[23].switch_endianness();
        self[24].switch_endianness();
    }
}

impl<T> Packed for [T;26] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
        self[11].switch_endianness();
        self[12].switch_endianness();
        self[13].switch_endianness();
        self[14].switch_endianness();
        self[15].switch_endianness();
        self[16].switch_endianness();
        self[17].switch_endianness();
        self[18].switch_endianness();
        self[19].switch_endianness();
        self[20].switch_endianness();
        self[21].switch_endianness();
        self[22].switch_endianness();
        self[23].switch_endianness();
        self[24].switch_endianness();
        self[25].switch_endianness();
    }
}

impl<T> Packed for [T;27] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
        self[11].switch_endianness();
        self[12].switch_endianness();
        self[13].switch_endianness();
        self[14].switch_endianness();
        self[15].switch_endianness();
        self[16].switch_endianness();
        self[17].switch_endianness();
        self[18].switch_endianness();
        self[19].switch_endianness();
        self[20].switch_endianness();
        self[21].switch_endianness();
        self[22].switch_endianness();
        self[23].switch_endianness();
        self[24].switch_endianness();
        self[25].switch_endianness();
        self[26].switch_endianness();
    }
}

impl<T> Packed for [T;28] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
        self[11].switch_endianness();
        self[12].switch_endianness();
        self[13].switch_endianness();
        self[14].switch_endianness();
        self[15].switch_endianness();
        self[16].switch_endianness();
        self[17].switch_endianness();
        self[18].switch_endianness();
        self[19].switch_endianness();
        self[20].switch_endianness();
        self[21].switch_endianness();
        self[22].switch_endianness();
        self[23].switch_endianness();
        self[24].switch_endianness();
        self[25].switch_endianness();
        self[26].switch_endianness();
        self[27].switch_endianness();
    }
}

impl<T> Packed for [T;29] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
        self[11].switch_endianness();
        self[12].switch_endianness();
        self[13].switch_endianness();
        self[14].switch_endianness();
        self[15].switch_endianness();
        self[16].switch_endianness();
        self[17].switch_endianness();
        self[18].switch_endianness();
        self[19].switch_endianness();
        self[20].switch_endianness();
        self[21].switch_endianness();
        self[22].switch_endianness();
        self[23].switch_endianness();
        self[24].switch_endianness();
        self[25].switch_endianness();
        self[26].switch_endianness();
        self[27].switch_endianness();
        self[28].switch_endianness();
    }
}

impl<T> Packed for [T;30] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
        self[11].switch_endianness();
        self[12].switch_endianness();
        self[13].switch_endianness();
        self[14].switch_endianness();
        self[15].switch_endianness();
        self[16].switch_endianness();
        self[17].switch_endianness();
        self[18].switch_endianness();
        self[19].switch_endianness();
        self[20].switch_endianness();
        self[21].switch_endianness();
        self[22].switch_endianness();
        self[23].switch_endianness();
        self[24].switch_endianness();
        self[25].switch_endianness();
        self[26].switch_endianness();
        self[27].switch_endianness();
        self[28].switch_endianness();
        self[29].switch_endianness();
    }
}

impl<T> Packed for [T;31] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
        self[11].switch_endianness();
        self[12].switch_endianness();
        self[13].switch_endianness();
        self[14].switch_endianness();
        self[15].switch_endianness();
        self[16].switch_endianness();
        self[17].switch_endianness();
        self[18].switch_endianness();
        self[19].switch_endianness();
        self[20].switch_endianness();
        self[21].switch_endianness();
        self[22].switch_endianness();
        self[23].switch_endianness();
        self[24].switch_endianness();
        self[25].switch_endianness();
        self[26].switch_endianness();
        self[27].switch_endianness();
        self[28].switch_endianness();
        self[29].switch_endianness();
        self[30].switch_endianness();
    }
}

impl<T> Packed for [T;32] where T: Packed {
    fn switch_endianness(&mut self) {
        self[0].switch_endianness();
        self[1].switch_endianness();
        self[2].switch_endianness();
        self[3].switch_endianness();
        self[4].switch_endianness();
        self[5].switch_endianness();
        self[6].switch_endianness();
        self[7].switch_endianness();
        self[8].switch_endianness();
        self[9].switch_endianness();
        self[10].switch_endianness();
        self[11].switch_endianness();
        self[12].switch_endianness();
        self[13].switch_endianness();
        self[14].switch_endianness();
        self[15].switch_endianness();
        self[16].switch_endianness();
        self[17].switch_endianness();
        self[18].switch_endianness();
        self[19].switch_endianness();
        self[20].switch_endianness();
        self[21].switch_endianness();
        self[22].switch_endianness();
        self[23].switch_endianness();
        self[24].switch_endianness();
        self[25].switch_endianness();
        self[26].switch_endianness();
        self[27].switch_endianness();
        self[28].switch_endianness();
        self[29].switch_endianness();
        self[30].switch_endianness();
        self[31].switch_endianness();
    }
}

/// `Unpacker` provides the `std::io::Read` API but for any type `T` implementing 
/// [`Packed`](trait.Packed.html). It does not perform any endianness conversion and thus always 
/// reads data using the system endianness.
///
/// # Example
/// 
/// Example of reading a file containing a few float samples.
/// 
/// ```no_run
/// use std::fs::File;
/// use std::iter::repeat;
///
/// use bytepack::Unpacker;
///
/// fn read_samples(file: &str) -> Vec<f32> {
///     let mut file = File::open(file).unwrap();
///     let num_samples : u32 = file.unpack().unwrap();
///     let mut samples : Vec<f32> = repeat(0f32).take(num_samples as usize).collect();
///     file.unpack_exact(&mut samples[..]).unwrap();
///     return samples;
/// }
/// ```
pub trait Unpacker {

    /// Unpack a single value of type `T`.
    ///
    /// ```no_run
    /// # use bytepack::Unpacker;
    /// # use std::fs::File;
    /// let mut file = File::open("test").unwrap();
    /// let float : f32 = file.unpack().unwrap();
    /// ```
    fn unpack<T: Packed>(&mut self) -> Result<T>;

    /// Unpack values of type `T` until `EOF` is reached and place them in `buf`. An error is 
    /// returned if the number of bytes read is not a multiple of the size of `T`.
    ///
    /// ```no_run
    /// # use bytepack::Unpacker;
    /// # use std::fs::File;
    /// let mut file = File::open("test").unwrap();
    /// let mut buffer = Vec::<u64>::new();
    /// file.unpack_to_end(&mut buffer).unwrap();
    /// ```
    fn unpack_to_end<T: Packed>(&mut self, buf: &mut Vec<T>) -> Result<usize>;

    /// Unpack the exact number of values of type `T` to fill `buf`. An error is 
    /// returned if not enough byte could be read.
    ///
    /// ```no_run
    /// # use bytepack::Unpacker;
    /// # use std::fs::File;
    /// let mut file = File::open("test").unwrap();
    /// let mut buffer = vec![0i32; 10];
    /// file.unpack_exact(&mut buffer[..]).unwrap();
    /// ```
    fn unpack_exact<T: Packed>(&mut self, buf: &mut [T]) -> Result<()>;
}

/// `Packer` provides the `std::io::Write` API but for any type `T` implementing 
/// [`Packed`](trait.Packed.html). It does not perform any endianness conversion and thus always 
/// writes data using the system endianness.
///
/// # Example
/// 
/// Example of writing a file containing a few float samples.
/// 
/// ```no_run
/// use std::fs::File;
/// use std::iter::repeat;
///
/// use bytepack::Packer;
///
/// fn write_samples(file: &str, samples: &Vec<f32>) {
///     let mut file = File::create(file).unwrap();
///     file.pack(samples.len() as u32).unwrap();
///     file.pack_all(&samples[..]).unwrap();
/// }
/// ```
pub trait Packer {

    /// Pack a single value of type `T`.
    ///
    /// ```no_run
    /// # use bytepack::Packer;
    /// # use std::fs::File;
    /// let mut file = File::create("test").unwrap();
    /// file.pack(42f32).unwrap();
    /// ```
    fn pack<T: Packed>(&mut self, t: T) -> Result<()>;

    /// Pack all the values of type `T` from `buf`.
    ///
    /// ```no_run
    /// # use bytepack::Packer;
    /// # use std::fs::File;
    /// let mut file = File::create("test").unwrap();
    /// let mut float_buffer = vec![666u16; 10];
    /// file.pack_all(&mut float_buffer[..]).unwrap();
    /// ```
    fn pack_all<T: Packed>(&mut self, buf: &[T]) -> Result<()>;
}

impl<R> Unpacker for R where R: Read {
    fn unpack<T: Packed>(&mut self) -> Result<T> {
        let mut res: T;
        // safe because we build a slice of exactly size_of::<T> bytes
        unsafe {
            res = zeroed();
            self.read_exact(slice::from_raw_parts_mut(transmute::<&mut T, *mut u8>(&mut res), size_of::<T>()))?;
        }
        return Ok(res);
    }

    fn unpack_to_end<T: Packed>(&mut self, buf: &mut Vec<T>) -> Result<usize> {
        // safe because converted is always forgotten before returning, capacity and length are 
        // always recomputed, in case of error buf is truncated to it's original data.
        unsafe {
            let length = buf.len();
            let capacity = buf.capacity();
            let mut converted = Vec::<u8>::from_raw_parts(buf.as_mut_ptr() as *mut u8, length * size_of::<T>(), capacity * size_of::<T>());
            match self.read_to_end(&mut converted) {
                Ok(size) => {
                    if converted.len() % size_of::<T>() != 0 {
                        converted.truncate(length * size_of::<T>());
                        let new_capacity = converted.len() / size_of::<T>();
                        *buf = Vec::from_raw_parts(converted.as_mut_ptr() as *mut T, length, new_capacity);
                        forget(converted);
                        return Err(Error::new(
                            ErrorKind::UnexpectedEof, 
                            format!("read_to_end() returned a number of bytes ({}) which is not a multiple of the size of T ({})", size, size_of::<T>())
                        ));
                    }
                },
                Err(e) => {
                    converted.truncate(length * size_of::<T>());
                    let new_capacity = converted.len() / size_of::<T>();
                    *buf = Vec::from_raw_parts(converted.as_mut_ptr() as *mut T, length, new_capacity);
                    forget(converted);
                    return Err(e);
                }
            };
            let new_length = converted.len() / size_of::<T>();
            let new_capacity = converted.len() / size_of::<T>();
            *buf = Vec::from_raw_parts(converted.as_mut_ptr() as *mut T, new_length, new_capacity);
            forget(converted);
            return Ok(new_length - length);
        }
    }

    fn unpack_exact<T: Packed>(&mut self, buf: &mut [T]) -> Result<()> {
        // safe because we build a slice of exactly buf.len() * size_of::<T> bytes
        unsafe {
            self.read_exact(slice::from_raw_parts_mut(buf.as_mut_ptr() as *mut u8, buf.len() * size_of::<T>()))
        }
    }
}

impl<W> Packer for W where W: Write {
    fn pack<T: Packed>(&mut self, t: T) -> Result<()> {
        // safe because we build a slice of exactly size_of::<T> bytes
        unsafe {
            self.write_all(slice::from_raw_parts(transmute::<&T, *const u8>(&t), size_of::<T>()))?;
        }
        return Ok(());
    }

    fn pack_all<T: Packed>(&mut self, t: &[T]) -> Result<()> {
        // safe because we build a slice of exactly t.len() * size_of::<T> bytes
        unsafe {
            self.write_all(slice::from_raw_parts(transmute::<*const T, *const u8>(t.as_ptr()), t.len() * size_of::<T>()))?;
        }
        return Ok(());
    }
}

/// Provides the same API and functionnality as [`Unpacker`](trait.Unpacker.html) but ensure that 
/// the data is in little endian format. See [`Unpacker`](trait.Unpacker.html) for more 
/// documentation.
pub trait LEUnpacker {
    fn unpack<T: Packed>(&mut self) -> Result<T>;
    fn unpack_to_end<T: Packed>(&mut self, buf: &mut Vec<T>) -> Result<usize>;
    fn unpack_exact<T: Packed>(&mut self, buf: &mut [T]) -> Result<()>;
}

/// Provides the same API and functionnality as [`Packer`](trait.Packer.html) but ensure that 
/// the data is in little endian format. See [`Packer`](trait.Packer.html) for more 
/// documentation.
pub trait LEPacker {
    fn pack<T: Packed>(&mut self, t: T) -> Result<()>;

    /// Here T needs to be `Clone` because the endianness switch cannot be done in-place. This method 
    /// thus allocates a copy of `buf` if an endianness switch is needed.
    fn pack_all<T: Packed + Clone>(&mut self, buf: &[T]) -> Result<()>;
}

impl<R> LEUnpacker for R where R: Read {
    fn unpack<T: Packed>(&mut self) -> Result<T> {
        if cfg!(target_endian = "big") {
            let mut t = Unpacker::unpack::<T>(self)?;
            t.switch_endianness();
            Ok(t)
        }
        else {
            Unpacker::unpack(self)
        }
    }

    fn unpack_to_end<T: Packed>(&mut self, buf: &mut Vec<T>) -> Result<usize> {
        if cfg!(target_endian = "big") {
            let size = Unpacker::unpack_to_end(self, buf)?;
            let start = buf.len() - size;
            for i in start..buf.len() {
                buf[i].switch_endianness();
            }
            Ok(size)
        }
        else {
            Unpacker::unpack_to_end(self, buf)
        }
    }

    fn unpack_exact<T: Packed>(&mut self, buf: &mut [T]) -> Result<()> {
        if cfg!(target_endian = "big") {
            Unpacker::unpack_exact(self, buf)?;
            for i in 0..buf.len() {
                buf[i].switch_endianness();
            }
            Ok(())
        }
        else {
            Unpacker::unpack_exact(self, buf)
        }
    }
}

impl<W> LEPacker for W where W: Write {
    fn pack<T: Packed>(&mut self, t: T) -> Result<()> {
        if cfg!(target_endian = "big") {
            let mut t_copy = t;
            t_copy.switch_endianness();
            Packer::pack(self, t_copy)
        }
        else {
            Packer::pack(self, t)
        }
    }

    fn pack_all<T: Packed + Clone>(&mut self, buf: &[T]) -> Result<()> {
        if cfg!(target_endian = "big") {
            let mut buf_copy = buf.to_vec();
            for i in 0..buf_copy.len() {
                buf_copy[i].switch_endianness();
            }
            Packer::pack_all(self, &buf_copy[..])
        }
        else {
            Packer::pack_all(self, buf)
        }
    }
}

/// Provides the same API and functionnality as [`Unpacker`](trait.Unpacker.html) but ensure that 
/// the data is in big endian format. See [`Unpacker`](trait.Unpacker.html) for more 
/// documentation.
pub trait BEUnpacker {
    fn unpack<T: Packed>(&mut self) -> Result<T>;
    fn unpack_to_end<T: Packed>(&mut self, buf: &mut Vec<T>) -> Result<usize>;
    fn unpack_exact<T: Packed>(&mut self, buf: &mut [T]) -> Result<()>;
}

/// Provides the same API and functionnality as [`Packer`](trait.Packer.html) but ensure that 
/// the data is in big endian format. See [`Packer`](trait.Packer.html) for more 
/// documentation.
pub trait BEPacker {
    fn pack<T: Packed>(&mut self, t: T) -> Result<()>;

    /// Here T needs to be `Clone` because the endianness switch cannot be done in-place. This method 
    /// thus allocates a copy of `buf` if an endianness switch is needed.
    fn pack_all<T: Packed + Clone>(&mut self, buf: &[T]) -> Result<()>;
}

impl<R> BEUnpacker for R where R: Read {
    fn unpack<T: Packed>(&mut self) -> Result<T> {
        if cfg!(target_endian = "big") {
            let mut t = Unpacker::unpack::<T>(self)?;
            t.switch_endianness();
            Ok(t)
        }
        else {
            Unpacker::unpack(self)
        }
    }

    fn unpack_to_end<T: Packed>(&mut self, buf: &mut Vec<T>) -> Result<usize> {
        if cfg!(target_endian = "big") {
            let size = Unpacker::unpack_to_end(self, buf)?;
            let start = buf.len() - size;
            for i in start..buf.len() {
                buf[i].switch_endianness();
            }
            Ok(size)
        }
        else {
            Unpacker::unpack_to_end(self, buf)
        }
    }

    fn unpack_exact<T: Packed>(&mut self, buf: &mut [T]) -> Result<()> {
        if cfg!(target_endian = "big") {
            Unpacker::unpack_exact(self, buf)?;
            for i in 0..buf.len() {
                buf[i].switch_endianness();
            }
            Ok(())
        }
        else {
            Unpacker::unpack_exact(self, buf)
        }
    }
}

impl<W> BEPacker for W where W: Write {
    fn pack<T: Packed>(&mut self, t: T) -> Result<()> {
        if cfg!(target_endian = "big") {
            let mut t_copy = t;
            t_copy.switch_endianness();
            Packer::pack(self, t_copy)
        }
        else {
            Packer::pack(self, t)
        }
    }

    fn pack_all<T: Packed + Clone>(&mut self, buf: &[T]) -> Result<()> {
        if cfg!(target_endian = "big") {
            let mut buf_copy = buf.to_vec();
            for i in 0..buf_copy.len() {
                buf_copy[i].switch_endianness();
            }
            Packer::pack_all(self, &buf_copy[..])
        }
        else {
            Packer::pack_all(self, buf)
        }
    }
}