crabmole 0.0.3

Porting Go standard library in Rust
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
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
macro_rules! assign_32 {
    ($src: ident, $dst: ident) => {
        $dst[0] = $src[0];
        $dst[1] = $src[1];
        $dst[2] = $src[2];
        $dst[3] = $src[3];
        $dst[4] = $src[4];
        $dst[5] = $src[5];
        $dst[6] = $src[6];
        $dst[7] = $src[7];
        $dst[8] = $src[8];
        $dst[9] = $src[9];
        $dst[10] = $src[10];
        $dst[11] = $src[11];
        $dst[12] = $src[12];
        $dst[13] = $src[13];
        $dst[14] = $src[14];
        $dst[15] = $src[15];
        $dst[16] = $src[16];
        $dst[17] = $src[17];
        $dst[18] = $src[18];
        $dst[19] = $src[19];
        $dst[20] = $src[20];
        $dst[21] = $src[21];
        $dst[22] = $src[22];
        $dst[23] = $src[23];
        $dst[24] = $src[24];
        $dst[25] = $src[25];
        $dst[26] = $src[26];
        $dst[27] = $src[27];
        $dst[28] = $src[28];
        $dst[29] = $src[29];
        $dst[30] = $src[30];
        $dst[31] = $src[31];
    };
}

const BASE: usize = 32;
const ENCODE_STD: [u8; BASE] = *b"ABCDEFGHIJKLMNOPQRSTUVWXYZ234567";
const ENCODE_HEX: [u8; BASE] = *b"0123456789ABCDEFGHIJKLMNOPQRSTUV";
const DECODE_MAP_INITIALIZE: [u8; 256] = [255; 256];

/// Error
#[derive(Debug, Clone, Eq, PartialEq)]
pub enum Error {
    /// Invalid encoder
    InvalidEncoder,

    /// Invalid padding character
    InvalidPadding,

    /// Padding character is contained in the alphabet
    PaddingContainedInAlphabet(char),
}

impl core::fmt::Display for Error {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Error::InvalidEncoder => write!(f, "Encoding alphabet must be 32 bytes long"),
            Error::InvalidPadding => write!(f, "Invalid padding character"),
            Error::PaddingContainedInAlphabet(ch) => {
                write!(f, "Padding character '{ch}' is contained in the alphabet")
            }
        }
    }
}

#[cfg(feature = "std")]
impl std::error::Error for Error {}

/// No padding
pub const NO_PADDING: Option<char> = None;

/// Standard padding
pub const STD_PADDING: Option<char> = Some('=');

/// The standard base32 encoding, as defined in
/// RFC 4648.
pub const STD_ENCODING: Encoding = Encoding::new(ENCODE_STD);

/// The `Extended Hex Alphabet` defined in RFC 4648.
// It is typically used in DNS.
pub const HEX_ENCODING: Encoding = Encoding::new(ENCODE_HEX);

/// An Encoding is a radix 32 encoding/decoding scheme, defined by a
/// 32-character alphabet. The most common is the "base32" encoding
/// introduced for SASL GSSAPI and standardized in RFC 4648.
/// The alternate "base32hex" encoding is used in DNSSEC.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, Ord, PartialOrd)]
pub struct Encoding {
    encode: [u8; BASE],
    decode_map: [u8; 256],
    pad_char: Option<char>,
}

impl Encoding {
    /// Returns a new Encoding defined by the given alphabet,
    /// which must be a 32-byte slice.
    #[inline]
    pub const fn new(encoder: [u8; BASE]) -> Self {
        let mut decode_map = DECODE_MAP_INITIALIZE;
        assign_32!(encoder, decode_map);
        decode_map[encoder[0] as usize] = 0;
        decode_map[encoder[1] as usize] = 1;
        decode_map[encoder[2] as usize] = 2;
        decode_map[encoder[3] as usize] = 3;
        decode_map[encoder[4] as usize] = 4;
        decode_map[encoder[5] as usize] = 5;
        decode_map[encoder[6] as usize] = 6;
        decode_map[encoder[7] as usize] = 7;
        decode_map[encoder[8] as usize] = 8;
        decode_map[encoder[9] as usize] = 9;
        decode_map[encoder[10] as usize] = 10;
        decode_map[encoder[11] as usize] = 11;
        decode_map[encoder[12] as usize] = 12;
        decode_map[encoder[13] as usize] = 13;
        decode_map[encoder[14] as usize] = 14;
        decode_map[encoder[15] as usize] = 15;
        decode_map[encoder[16] as usize] = 16;
        decode_map[encoder[17] as usize] = 17;
        decode_map[encoder[18] as usize] = 18;
        decode_map[encoder[19] as usize] = 19;
        decode_map[encoder[20] as usize] = 20;
        decode_map[encoder[21] as usize] = 21;
        decode_map[encoder[22] as usize] = 22;
        decode_map[encoder[23] as usize] = 23;
        decode_map[encoder[24] as usize] = 24;
        decode_map[encoder[25] as usize] = 25;
        decode_map[encoder[26] as usize] = 26;
        decode_map[encoder[27] as usize] = 27;
        decode_map[encoder[28] as usize] = 28;
        decode_map[encoder[29] as usize] = 29;
        decode_map[encoder[30] as usize] = 30;
        decode_map[encoder[31] as usize] = 31;

        Encoding {
            encode: encoder,
            decode_map,
            pad_char: Some('='),
        }
    }

    /// Creates a new encoding identical to enc except
    /// with a specified padding character, or NoPadding to disable padding.
    /// The padding character must not be '\r' or '\n', must not
    /// be contained in the encoding's alphabet and must be a rune equal or
    /// below '\xff'.
    #[inline]
    pub const fn with_padding(mut self, padding: Option<char>) -> Self {
        self.pad_char = padding;
        self
    }

    /// Returns an encoder
    #[cfg(feature = "std")]
    #[inline]
    pub const fn encoder<W: std::io::Write>(&self, writer: W) -> Encoder<W> {
        Encoder::new(*self, writer)
    }

    /// Returns a decoder
    ///
    /// See [`Decoder::decoder_without_newlines`] if you want to decode source without newlines.
    #[cfg(feature = "std")]
    #[inline]
    pub const fn decoder<R: std::io::Read>(&self, reader: R) -> Decoder<R> {
        Decoder::new(*self, reader)
    }

    /// Returns a decoder which ignore the newline characters
    #[cfg(feature = "std")]
    #[inline]
    pub const fn decoder_without_newlines<R: std::io::Read>(
        &self,
        reader: R,
    ) -> Decoder<NewLineFilteringReader<R>> {
        Decoder::new(*self, NewLineFilteringReader::new(reader))
    }

    /// Returns the length in bytes of the base32 encoding
    /// of source slice.
    #[inline]
    pub const fn encoded_len(&self, n: usize) -> usize {
        if self.pad_char.is_none() {
            return (n * 8 + 4) / 5;
        }

        (n + 4) / 5 * 8
    }

    /// Encodes `src` using the encoding enc, writing
    /// `encoded_len(src)` bytes to dst.
    ///
    /// The encoding pads the output to a multiple of 8 bytes,
    /// so Encode is not appropriate for use on individual blocks
    /// of a large data stream. Use NewEncoder() instead.
    #[inline]
    pub fn encode(&self, mut src: &[u8], mut dst: &mut [u8]) {
        while !src.is_empty() {
            let mut b = [0; 8];

            // Unpack 8x 5-bit source blocks into a 5 byte
            // destination quantum
            match src.len() {
                4 => {
                    b[6] |= (src[3] << 3) & 0x1F;
                    b[5] = (src[3] >> 2) & 0x1F;
                    b[4] = src[3] >> 7;
                    b[4] |= (src[2] << 1) & 0x1F;
                    b[3] = (src[2] >> 4) & 0x1F;
                    b[3] |= (src[1] << 4) & 0x1F;
                    b[2] = (src[1] >> 1) & 0x1F;
                    b[1] = (src[1] >> 6) & 0x1F;
                    b[1] |= (src[0] << 2) & 0x1F;
                    b[0] = src[0] >> 3;
                }
                3 => {
                    b[4] |= (src[2] << 1) & 0x1F;
                    b[3] = (src[2] >> 4) & 0x1F;
                    b[3] |= (src[1] << 4) & 0x1F;
                    b[2] = (src[1] >> 1) & 0x1F;
                    b[1] = (src[1] >> 6) & 0x1F;
                    b[1] |= (src[0] << 2) & 0x1F;
                    b[0] = src[0] >> 3;
                }
                2 => {
                    b[3] |= (src[1] << 4) & 0x1F;
                    b[2] = (src[1] >> 1) & 0x1F;
                    b[1] = (src[1] >> 6) & 0x1F;
                    b[1] |= (src[0] << 2) & 0x1F;
                    b[0] = src[0] >> 3;
                }
                1 => {
                    b[1] |= (src[0] << 2) & 0x1F;
                    b[0] = src[0] >> 3;
                }
                _ => {
                    b[7] = src[4] & 0x1F;
                    b[6] = src[4] >> 5;
                    b[6] |= (src[3] << 3) & 0x1F;
                    b[5] = (src[3] >> 2) & 0x1F;
                    b[4] = src[3] >> 7;
                    b[4] |= (src[2] << 1) & 0x1F;
                    b[3] = (src[2] >> 4) & 0x1F;
                    b[3] |= (src[1] << 4) & 0x1F;
                    b[2] = (src[1] >> 1) & 0x1F;
                    b[1] = (src[1] >> 6) & 0x1F;
                    b[1] |= (src[0] << 2) & 0x1F;
                    b[0] = src[0] >> 3;
                }
            }

            // Encode 5-bit blocks using the base32 alphabet
            let size = dst.len();
            if size >= 8 {
                // Common case, unrolled for extra performance
                dst[0] = self.encode[b[0] as usize & 31];
                dst[1] = self.encode[b[1] as usize & 31];
                dst[2] = self.encode[b[2] as usize & 31];
                dst[3] = self.encode[b[3] as usize & 31];
                dst[4] = self.encode[b[4] as usize & 31];
                dst[5] = self.encode[b[5] as usize & 31];
                dst[6] = self.encode[b[6] as usize & 31];
                dst[7] = self.encode[b[7] as usize & 31];
            } else {
                for i in 0..size {
                    dst[i] = self.encode[b[i] as usize & 31];
                }
            }

            // Pad the final quantum
            if src.len() < 5 {
                if let Some(padding) = self.pad_char {
                    dst[7] = padding as u8;
                    if src.len() < 4 {
                        dst[6] = padding as u8;
                        dst[5] = padding as u8;
                        if src.len() < 3 {
                            dst[4] = padding as u8;
                            if src.len() < 2 {
                                dst[3] = padding as u8;
                                dst[2] = padding as u8;
                            }
                        }
                    }
                } else {
                    break;
                }

                break;
            }

            src = &src[5..];
            dst = &mut dst[8..];
        }
    }

    /// Returns the base32 encoding of src.
    #[cfg(feature = "alloc")]
    pub fn encode_to_vec(&self, src: &[u8]) -> alloc::vec::Vec<u8> {
        let mut dst = alloc::vec![0; self.encoded_len(src.len())];
        self.encode(src, &mut dst);
        dst
    }

    /// Decodes src using the encoding enc. It writes at most
    /// DecodedLen(len(src)) bytes to dst and returns the number of bytes
    /// written. If src contains invalid base32 data, it will return the
    /// number of bytes successfully written and DecodeError.
    ///
    /// See `decode_without_newline` if you want to ignore the newline characters
    #[inline]
    pub fn decode(&self, src: &[u8], dst: &mut [u8]) -> Result<usize, DecodeError> {
        self.decode_in(src, dst).map(|(n, _)| n)
    }

    /// Returns the bytes represented by the base32 slice.
    #[inline]
    #[cfg(feature = "alloc")]
    pub fn decode_to_vec(&self, src: &[u8]) -> Result<alloc::vec::Vec<u8>, DecodeError> {
        let mut dst = src.to_vec();
        self.decode_in(src, &mut dst).map(|(n, _)| {
            dst.truncate(n);
            dst
        })
    }

    /// Decodes src using the encoding enc. It writes at most
    /// DecodedLen(len(src)) bytes to dst and returns the number of bytes
    /// written. If src contains invalid base32 data, it will return the
    /// number of bytes successfully written and DecodeError.
    /// New line characters (`\r` and `\n`) are ignored.
    #[inline]
    #[cfg(feature = "alloc")]
    pub fn decode_without_newline(&self, src: &[u8], dst: &mut [u8]) -> Result<usize, DecodeError> {
        let mut buf = src.to_vec();
        let l = strip_new_lines_inplace(&mut buf);
        self.decode_in(&buf[..l], dst).map(|(n, _)| n)
    }

    /// Returns the bytes represented by the base32 slice (ignore newline characters (`\r` and `\n`)).
    #[inline]
    #[cfg(feature = "alloc")]
    pub fn decode_without_newline_to_vec(
        &self,
        src: &[u8],
    ) -> Result<alloc::vec::Vec<u8>, DecodeError> {
        let mut buf = src.to_vec();
        let l = strip_new_lines_inplace(&mut buf);
        self.decode_inplace(&mut buf, l).map(|(n, _)| {
            buf.truncate(n);
            buf
        })
    }

    #[inline]
    fn decode_inplace(&self, dst: &mut [u8], src_len: usize) -> Result<(usize, bool), DecodeError> {
        let mut n = 0;
        let mut end = false;
        let mut dsti = 0;
        let src = dst;
        let olen = src_len;

        let mut src_start = 0;
        let src_end = src_len;
        while !src[src_start..src_end].is_empty() && !end {
            // Decode quantum using the base32 alphabet
            let mut dbuf = [0; 8];
            let mut dlen = 8;

            let mut j = 0;
            while j < 8 {
                if src[src_start..src_end].is_empty() {
                    if self.pad_char.is_some() {
                        // We have reached the end and are missing padding
                        return Err(DecodeError(olen - (src_end - src_start) - j));
                    }
                    // We have reached the end and are not expecting any padding
                    (dlen, end) = (j, true);
                    break;
                }

                let in_ = src[src_start];
                // src = &mut src[src_start + 1..];
                src_start += 1;

                match self.pad_char {
                    Some(padding)
                        if padding == (in_ as char) && j >= 2 && (src_end - src_start) < 8 =>
                    {
                        // We've reached the end and there's padding
                        if (src_end - src_start) + j < 8 - 1 {
                            // not enough padding
                            return Err(DecodeError(olen));
                        }

                        let mut k = 0;
                        while k < 8 - 1 - j {
                            if (src_end - src_start) > k && (src[src_start + k] as char) != padding
                            {
                                // incorrect padding
                                return Err(DecodeError(olen - (src_end - src_start)));
                            }
                            k += 1;
                        }

                        (dlen, end) = (j, true);

                        // 7, 5 and 2 are not valid padding lengths, and so 1, 3 and 6 are not
                        // valid dlen values. See RFC 4648 Section 6 "Base 32 Encoding" listing
                        // the five valid padding lengths, and Section 9 "Illustrations and
                        // Examples" for an illustration for how the 1st, 3rd and 6th base32
                        // src bytes do not yield enough information to decode a dst byte.
                        if dlen == 1 || dlen == 3 || dlen == 6 {
                            return Err(DecodeError(olen - (src_end - src_start) - 1));
                        }
                        break;
                    }
                    _ => {
                        dbuf[j] = self.decode_map[in_ as usize];
                        if dbuf[j] == 0xFF {
                            return Err(DecodeError(olen - (src_end - src_start) - 1));
                        }
                        j += 1;
                    }
                }
            }

            // Pack 8x 5-bit source blocks into 5 byte destination
            // quantum
            match dlen {
                8 => {
                    src[dsti + 4] = dbuf[6] << 5 | dbuf[7];
                    n += 1;
                    src[dsti + 3] = dbuf[4] << 7 | dbuf[5] << 2 | dbuf[6] >> 3;
                    n += 1;
                    src[dsti + 2] = dbuf[3] << 4 | dbuf[4] >> 1;
                    n += 1;
                    src[dsti + 1] = dbuf[1] << 6 | dbuf[2] << 1 | dbuf[3] >> 4;
                    n += 1;
                    src[dsti] = dbuf[0] << 3 | dbuf[1] >> 2;
                    n += 1;
                }
                7 => {
                    src[dsti + 3] = dbuf[4] << 7 | dbuf[5] << 2 | dbuf[6] >> 3;
                    n += 1;
                    src[dsti + 2] = dbuf[3] << 4 | dbuf[4] >> 1;
                    n += 1;
                    src[dsti + 1] = dbuf[1] << 6 | dbuf[2] << 1 | dbuf[3] >> 4;
                    n += 1;
                    src[dsti] = dbuf[0] << 3 | dbuf[1] >> 2;
                    n += 1;
                }
                5 => {
                    src[dsti + 2] = dbuf[3] << 4 | dbuf[4] >> 1;
                    n += 1;
                    src[dsti + 1] = dbuf[1] << 6 | dbuf[2] << 1 | dbuf[3] >> 4;
                    n += 1;
                    src[dsti] = dbuf[0] << 3 | dbuf[1] >> 2;
                    n += 1;
                }
                4 => {
                    src[dsti + 1] = dbuf[1] << 6 | dbuf[2] << 1 | dbuf[3] >> 4;
                    n += 1;
                    src[dsti] = dbuf[0] << 3 | dbuf[1] >> 2;
                    n += 1;
                }
                2 => {
                    src[dsti] = dbuf[0] << 3 | dbuf[1] >> 2;
                    n += 1;
                }
                _ => {}
            }
            dsti += 5;
        }
        Ok((n, end))
    }

    /// Returns the maximum length in bytes of the decoded data
    /// corresponding to n bytes of base32-encoded data.
    #[inline]
    pub const fn decode_len(&self, n: usize) -> usize {
        if self.pad_char.is_none() {
            return n * 5 / 8;
        }
        n / 8 * 5
    }

    /// Returns an additional 'end' value, which
    /// indicates if end-of-message padding was encountered and thus any
    /// additional data is an error. This method assumes that src has been
    /// stripped of all supported whitespace ('\r' and '\n').
    #[inline]
    fn decode_in(&self, mut src: &[u8], dst: &mut [u8]) -> Result<(usize, bool), DecodeError> {
        let mut n = 0;
        let mut end = false;
        let mut dsti = 0;
        let olen = src.len();

        while !src.is_empty() && !end {
            // Decode quantum using the base32 alphabet
            let mut dbuf = [0; 8];
            let mut dlen = 8;

            let mut j = 0;
            while j < 8 {
                if src.is_empty() {
                    if self.pad_char.is_some() {
                        // We have reached the end and are missing padding
                        return Err(DecodeError(olen - src.len() - j));
                    }
                    // We have reached the end and are not expecting any padding
                    (dlen, end) = (j, true);
                    break;
                }

                let in_ = src[0];
                src = &src[1..];

                match self.pad_char {
                    Some(padding) if padding == (in_ as char) && j >= 2 && src.len() < 8 => {
                        // We've reached the end and there's padding
                        if src.len() + j < 8 - 1 {
                            // not enough padding
                            return Err(DecodeError(olen));
                        }

                        let mut k = 0;
                        while k < 8 - 1 - j {
                            if src.len() > k && (src[k] as char) != padding {
                                // incorrect padding
                                return Err(DecodeError(olen - src.len()));
                            }
                            k += 1;
                        }

                        (dlen, end) = (j, true);

                        // 7, 5 and 2 are not valid padding lengths, and so 1, 3 and 6 are not
                        // valid dlen values. See RFC 4648 Section 6 "Base 32 Encoding" listing
                        // the five valid padding lengths, and Section 9 "Illustrations and
                        // Examples" for an illustration for how the 1st, 3rd and 6th base32
                        // src bytes do not yield enough information to decode a dst byte.
                        if dlen == 1 || dlen == 3 || dlen == 6 {
                            return Err(DecodeError(olen - src.len() - 1));
                        }
                        break;
                    }
                    _ => {
                        dbuf[j] = self.decode_map[in_ as usize];
                        if dbuf[j] == 0xFF {
                            return Err(DecodeError(olen - src.len() - 1));
                        }
                        j += 1;
                    }
                }
            }

            // Pack 8x 5-bit source blocks into 5 byte destination
            // quantum
            match dlen {
                8 => {
                    dst[dsti + 4] = dbuf[6] << 5 | dbuf[7];
                    n += 1;
                    dst[dsti + 3] = dbuf[4] << 7 | dbuf[5] << 2 | dbuf[6] >> 3;
                    n += 1;
                    dst[dsti + 2] = dbuf[3] << 4 | dbuf[4] >> 1;
                    n += 1;
                    dst[dsti + 1] = dbuf[1] << 6 | dbuf[2] << 1 | dbuf[3] >> 4;
                    n += 1;
                    dst[dsti] = dbuf[0] << 3 | dbuf[1] >> 2;
                    n += 1;
                }
                7 => {
                    dst[dsti + 3] = dbuf[4] << 7 | dbuf[5] << 2 | dbuf[6] >> 3;
                    n += 1;
                    dst[dsti + 2] = dbuf[3] << 4 | dbuf[4] >> 1;
                    n += 1;
                    dst[dsti + 1] = dbuf[1] << 6 | dbuf[2] << 1 | dbuf[3] >> 4;
                    n += 1;
                    dst[dsti] = dbuf[0] << 3 | dbuf[1] >> 2;
                    n += 1;
                }
                5 => {
                    dst[dsti + 2] = dbuf[3] << 4 | dbuf[4] >> 1;
                    n += 1;
                    dst[dsti + 1] = dbuf[1] << 6 | dbuf[2] << 1 | dbuf[3] >> 4;
                    n += 1;
                    dst[dsti] = dbuf[0] << 3 | dbuf[1] >> 2;
                    n += 1;
                }
                4 => {
                    dst[dsti + 1] = dbuf[1] << 6 | dbuf[2] << 1 | dbuf[3] >> 4;
                    n += 1;
                    dst[dsti] = dbuf[0] << 3 | dbuf[1] >> 2;
                    n += 1;
                }
                2 => {
                    dst[dsti] = dbuf[0] << 3 | dbuf[1] >> 2;
                    n += 1;
                }
                _ => {}
            }
            dsti += 5;
        }
        Ok((n, end))
    }
}

/// Removes newline characters and returns the number
/// of non-newline characters copied to dst.
#[inline]
fn strip_new_lines_inplace(dst: &mut [u8]) -> usize {
    let mut offset = 0;
    for i in 0..dst.len() {
        let b = dst[i];
        if b.eq(&b'\r') || b.eq(&b'\n') {
            continue;
        }
        dst[offset] = b;
        offset += 1;
    }
    offset
}

/// Wrong input for decoding
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct DecodeError(usize);

impl core::fmt::Display for DecodeError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        writeln!(f, "illegal base32 data at input byte {}", self.0)
    }
}

#[cfg(feature = "std")]
impl std::error::Error for DecodeError {}

/// Base32 encoder
#[cfg(feature = "std")]
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Encoder<W> {
    enc: Encoding,
    writer: W,
    buf: [u8; 5],
    nbuf: usize,
    out: [u8; 1024],
}

#[cfg(feature = "std")]
impl<W> Encoder<W> {
    /// Returns a new base32 stream encoder. Data written to
    /// the returned writer will be encoded using enc and then written to w.
    /// Base32 encodings operate in 5-byte blocks; when finished
    /// writing, the caller must **Flush** the returned encoder to flush any
    /// partially written blocks.
    #[inline]
    pub const fn new(enc: Encoding, writer: W) -> Self {
        Self {
            enc,
            writer,
            buf: [0; 5],
            nbuf: 0,
            out: [0; 1024],
        }
    }
}

#[cfg(feature = "std")]
impl<W: std::io::Write> std::io::Write for Encoder<W> {
    fn write(&mut self, mut buf: &[u8]) -> std::io::Result<usize> {
        let mut n = 0;

        // leading fringe.
        if self.nbuf > 0 {
            let mut i = 0;
            while i < buf.len() && self.nbuf < 5 {
                self.buf[self.nbuf] = buf[i];
                self.nbuf += 1;
                i += 1;
            }
            n += i;
            buf = &buf[i..];
            if self.nbuf < 5 {
                return Ok(n);
            }
            self.enc.encode(&self.buf, &mut self.out);
            self.writer.write_all(&self.out[..8])?;
            self.nbuf = 0;
        }

        // Large interior chunks.
        while buf.len() >= 5 {
            let mut nn = self.out.len() / 8 * 5;
            if nn > buf.len() {
                nn = buf.len();
                nn -= nn % 5;
            }

            self.enc.encode(&buf[..nn], &mut self.out);
            self.writer.write_all(&self.out[..nn / 5 * 8])?;
            n += nn;
            buf = &buf[nn..];
        }

        // Trailing fringe.
        // Safety: buf.len() always less of equal to self.buf.len()
        crate::copy(buf, &mut self.buf);
        self.nbuf = buf.len();
        n += buf.len();
        Ok(n)
    }

    fn flush(&mut self) -> std::io::Result<()> {
        self.enc.encode(&self.buf[..self.nbuf], &mut self.out);
        let encoded_len = self.enc.encoded_len(self.nbuf);
        self.nbuf = 0;
        self.writer.write_all(&self.out[..encoded_len])
    }
}

/// A reader wrapper can filter newline characters when decoding base32 stream.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(transparent)]
pub struct NewLineFilteringReader<R> {
    wrapped: R,
}

#[cfg(feature = "std")]
impl<R: std::io::Read> NewLineFilteringReader<R> {
    /// Creates a `NewlineFilteringReader` that wraps the given reader.
    #[inline]
    pub const fn new(reader: R) -> NewLineFilteringReader<R> {
        NewLineFilteringReader { wrapped: reader }
    }
}

#[cfg(feature = "std")]
impl<R: std::io::Read> From<R> for NewLineFilteringReader<R> {
    fn from(value: R) -> Self {
        Self { wrapped: value }
    }
}

impl<R: std::io::Read> std::io::Read for NewLineFilteringReader<R> {
    fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
        match self.wrapped.read(buf) {
            Ok(mut n) => {
                while n > 0 {
                    let s = &mut buf[..n];
                    let offset = strip_new_lines_inplace(s);
                    if offset > 0 {
                        return Ok(offset);
                    }

                    // Previous buffer entirely whitespace, read again
                    n = self.wrapped.read(buf)?;
                }
                Ok(n)
            }
            Err(e) => Err(e),
        }
    }
}

#[inline]
fn read_encoded_data(
    r: &mut impl std::io::Read,
    buf: &mut [u8],
    min: usize,
    expects_padding: bool,
) -> std::io::Result<usize> {
    let mut n = 0;
    while n < min {
        n += r.read(&mut buf[n..])?;
        if n == 0 {
            break;
        }
    }

    // data was read, less than min bytes could be read
    if n < min && n > 0 {
        return Err(std::io::Error::new(
            std::io::ErrorKind::UnexpectedEof,
            "base32 decoder: data was read, less than min bytes could be read",
        ));
    }

    // no data was read, the buffer already contains some data
    // when padding is disabled this is not an error, as the message can be of
    // any length
    if expects_padding && min < 8 && n == 0 {
        return Err(std::io::Error::new(
            std::io::ErrorKind::UnexpectedEof,
            "base32 decoder: no data was read, the buffer already contains some data",
        ));
    }
    Ok(n)
}

/// Base32 decoder
#[cfg(feature = "std")]
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Decoder<R> {
    enc: Encoding,
    reader: R,
    end: bool,
    buf: [u8; 1024],
    nbuf: usize,
    out: std::vec::Vec<u8>,
    out_buf: [u8; 1024 / 8 * 5],
}

#[cfg(feature = "std")]
impl<R> Decoder<R> {
    /// Constructs a new base32 stream decoder.
    #[inline]
    pub const fn new(enc: Encoding, reader: R) -> Self {
        Self {
            enc,
            reader,
            end: false,
            buf: [0; 1024],
            nbuf: 0,
            out: std::vec::Vec::new(),
            out_buf: [0; 1024 / 8 * 5],
        }
    }

    /// Constructs a new base32 stream decoder.
    #[inline]
    pub const fn with_newline_filter(
        enc: Encoding,
        reader: R,
    ) -> Decoder<NewLineFilteringReader<R>> {
        Decoder {
            enc,
            reader: NewLineFilteringReader { wrapped: reader },
            end: false,
            buf: [0; 1024],
            nbuf: 0,
            out: std::vec::Vec::new(),
            out_buf: [0; 1024 / 8 * 5],
        }
    }
}

#[cfg(feature = "std")]
impl<R: std::io::Read> std::io::Read for Decoder<R> {
    fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
        let n;
        // Use leftover decoded output from last read.
        if !self.out.is_empty() {
            n = crate::copy(&self.out, buf);
            self.out.drain(..self.out.len().min(n));
            return Ok(n);
        }

        // Read a chunk
        let mut nn = (buf.len() / 5 * 8).clamp(8, 1024);

        // Minimum amount of bytes that needs to be read each cycle
        let (min, expects_padding) = match self.enc.pad_char {
            Some(_) => (8 - self.nbuf, true),
            None => (1, false),
        };

        nn = read_encoded_data(
            &mut self.reader,
            &mut self.buf[self.nbuf..nn],
            min,
            expects_padding,
        )?;
        self.nbuf += nn;
        if self.nbuf < min {
            return Ok(0);
        }

        if nn > 0 && self.end {
            return Err(std::io::Error::new(
                std::io::ErrorKind::Other,
                DecodeError(0),
            ));
        }

        // Decode chunk into p, or d.out and then p if p is too small.
        let nr = match self.enc.pad_char {
            Some(_) => self.nbuf / 8 * 8,
            None => self.nbuf,
        };

        let mut nw = self.enc.decode_len(self.nbuf);
        if nw > buf.len() {
            (nw, self.end) = self
                .enc
                .decode_in(&self.buf[..nr], &mut self.out_buf)
                .map_err(|e| std::io::Error::new(std::io::ErrorKind::Other, e))?;
            self.out = self.out_buf[..nw].to_vec();
            n = crate::copy(&self.out, buf);
            self.out.drain(..n);
        } else {
            (n, self.end) = self
                .enc
                .decode_in(&self.buf[..nr], buf)
                .map_err(|e| std::io::Error::new(std::io::ErrorKind::Other, e))?;
        }
        self.nbuf -= nr;
        for i in 0..self.nbuf {
            self.buf[i] = self.buf[i + nr];
        }

        Ok(n)
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use std::io::{Read, Write};

    struct TestPair {
        decoded: String,
        encoded: String,
    }

    fn pairs() -> Vec<TestPair> {
        vec![
            // RFC 4648 examples
            TestPair {
                decoded: Default::default(),
                encoded: Default::default(),
            },
            TestPair {
                decoded: "f".to_string(),
                encoded: "MY======".to_string(),
            },
            TestPair {
                decoded: "fo".to_string(),
                encoded: "MZXQ====".to_string(),
            },
            TestPair {
                decoded: "foo".to_string(),
                encoded: "MZXW6===".to_string(),
            },
            TestPair {
                decoded: "foob".to_string(),
                encoded: "MZXW6YQ=".to_string(),
            },
            TestPair {
                decoded: "fooba".to_string(),
                encoded: "MZXW6YTB".to_string(),
            },
            TestPair {
                decoded: "foobar".to_string(),
                encoded: "MZXW6YTBOI======".to_string(),
            },
            // Wikipedia examples, converted to base32
            TestPair {
                decoded: "sure.".to_string(),
                encoded: "ON2XEZJO".to_string(),
            },
            TestPair {
                decoded: "sure".to_string(),
                encoded: "ON2XEZI=".to_string(),
            },
            TestPair {
                decoded: "sur".to_string(),
                encoded: "ON2XE===".to_string(),
            },
            TestPair {
                decoded: "su".to_string(),
                encoded: "ON2Q====".to_string(),
            },
            TestPair {
                decoded: "leasure.".to_string(),
                encoded: "NRSWC43VOJSS4===".to_string(),
            },
            TestPair {
                decoded: "easure.".to_string(),
                encoded: "MVQXG5LSMUXA====".to_string(),
            },
            TestPair {
                decoded: "asure.".to_string(),
                encoded: "MFZXK4TFFY======".to_string(),
            },
            TestPair {
                decoded: "sure.".to_string(),
                encoded: "ON2XEZJO".to_string(),
            },
        ]
    }

    fn big_test() -> TestPair {
        TestPair {
            decoded: "Twas brillig, and the slithy toves".to_string(),
            encoded: "KR3WC4ZAMJZGS3DMNFTSYIDBNZSCA5DIMUQHG3DJORUHSIDUN53GK4Y=".to_string(),
        }
    }

    #[test]
    fn test_encode() {
        for p in pairs() {
            let got = STD_ENCODING.encode_to_vec(p.decoded.as_bytes());
            assert_eq!(got, p.encoded.as_bytes());
        }
    }

    #[test]
    fn test_encoder() {
        for p in pairs() {
            let mut got = Vec::new();
            let mut encoder = STD_ENCODING.encoder(&mut got);
            let _ = encoder.write(p.decoded.as_bytes()).unwrap();
            encoder.flush().unwrap();
            assert_eq!(got, p.encoded.as_bytes());
        }
    }

    #[test]
    fn test_encoder_buffering() {
        let input = big_test();
        for bs in 1..=12 {
            let mut bb = Vec::new();
            let mut encoder = STD_ENCODING.encoder(&mut bb);
            let mut pos = 0;
            while pos < input.decoded.len() {
                let mut end = pos + bs;
                if end > input.decoded.len() {
                    end = input.decoded.len();
                }

                let n = encoder.write(&input.decoded.as_bytes()[pos..end]).unwrap();
                assert_eq!(n, end - pos);
                pos += bs;
            }

            encoder.flush().unwrap();
            assert_eq!(bb, input.encoded.as_bytes());
        }
    }

    #[test]
    fn test_decode() {
        for p in pairs() {
            let mut dbuf = vec![0; STD_ENCODING.decode_len(p.encoded.len())];
            let (n, end) = STD_ENCODING
                .decode_in(p.encoded.as_bytes(), &mut dbuf)
                .unwrap();
            assert_eq!(n, p.decoded.len());
            if !p.encoded.is_empty() {
                assert_eq!(end, p.encoded.as_bytes()[p.encoded.len() - 1] == b'=');
            }
            assert_eq!(&dbuf[..n], p.decoded.as_bytes());

            let dbuf = STD_ENCODING.decode_to_vec(p.encoded.as_bytes()).unwrap();
            assert_eq!(dbuf, p.decoded.as_bytes());
        }
    }

    #[test]
    fn test_decoder() {
        for p in pairs() {
            let mut reader = p.encoded.as_bytes().to_vec();
            let mut decoder = Encoding::new(ENCODE_STD).decoder(std::io::Cursor::new(&mut reader));
            let mut dbuf = vec![0; STD_ENCODING.decode_len(p.encoded.len())];
            match decoder.read(&mut dbuf) {
                Ok(n) => {
                    assert_eq!(n, p.decoded.len());
                    assert_eq!(&dbuf[..n], p.decoded.as_bytes());
                }
                Err(e) => {
                    assert_eq!(e.kind(), std::io::ErrorKind::UnexpectedEof);
                }
            }
        }
    }

    #[test]
    fn test_decoder_buffering() {
        let big = big_test();
        for bs in 1..=12 {
            let mut decoder = STD_ENCODING.decoder(std::io::Cursor::new(big.encoded.as_bytes()));
            let mut buf = vec![0; big.decoded.len() + 12];
            let mut total = 0;
            while total < big.decoded.len() {
                match decoder.read(&mut buf[total..total + bs]) {
                    Ok(nn) => {
                        total += nn;
                    }
                    Err(e) => {
                        if e.kind() != std::io::ErrorKind::UnexpectedEof {
                            panic!("unexpected error: {}", e);
                        }
                        break;
                    }
                }
            }
            assert_eq!(big.decoded.as_bytes(), &buf[..total]);
        }
    }

    #[test]
    fn test_decode_corrupt() {
        struct Case {
            input: &'static str,
            offset: isize, // -1 means no corruption.
        }

        let cases = vec![
            Case {
                input: "",
                offset: -1,
            },
            Case {
                input: "!!!!",
                offset: 0,
            },
            Case {
                input: "x===",
                offset: 0,
            },
            Case {
                input: "AA=A====",
                offset: 2,
            },
            Case {
                input: "AAA=AAAA",
                offset: 3,
            },
            Case {
                input: "MMMMMMMMM",
                offset: 8,
            },
            Case {
                input: "MMMMMM",
                offset: 0,
            },
            Case {
                input: "A=",
                offset: 1,
            },
            Case {
                input: "AA=",
                offset: 3,
            },
            Case {
                input: "AA==",
                offset: 4,
            },
            Case {
                input: "AA===",
                offset: 5,
            },
            Case {
                input: "AAAA=",
                offset: 5,
            },
            Case {
                input: "AAAA==",
                offset: 6,
            },
            Case {
                input: "AAAAA=",
                offset: 6,
            },
            Case {
                input: "AAAAA==",
                offset: 7,
            },
            Case {
                input: "A=======",
                offset: 1,
            },
            Case {
                input: "AA======",
                offset: -1,
            },
            Case {
                input: "AAA=====",
                offset: 3,
            },
            Case {
                input: "AAAA====",
                offset: -1,
            },
            Case {
                input: "AAAAA===",
                offset: -1,
            },
            Case {
                input: "AAAAAA==",
                offset: 6,
            },
            Case {
                input: "AAAAAAA=",
                offset: -1,
            },
            Case {
                input: "AAAAAAAA",
                offset: -1,
            },
        ];

        for c in cases {
            let mut dbuf = vec![0; STD_ENCODING.decode_len(c.input.len())];
            let x = STD_ENCODING.decode(c.input.as_bytes(), &mut dbuf);
            if c.offset == -1 {
                assert!(x.is_ok());
                continue;
            }

            assert!(x.is_err());
        }
    }

    #[test]
    fn test_big() {
        let n = 3 * 1000 + 1;
        let mut raw = vec![0; n];
        const ALPHA: &[u8] = b"0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
        for i in 0..n {
            raw[i] = ALPHA[i % ALPHA.len()];
        }
        let mut encoded = vec![];
        let mut w = STD_ENCODING.encoder(&mut encoded);
        let _ = w.write(&raw).unwrap();
        w.flush().unwrap();
        eprintln!("encoded: {}", encoded.len());

        let mut dst = String::new();
        STD_ENCODING
            .decoder(std::io::Cursor::new(&encoded))
            .read_to_string(&mut dst)
            .unwrap();
        assert_eq!(raw, dst.as_bytes());
    }

    #[test]
    fn test_new_line_characters() {
        let test_string_encode = |expected: &str, examples: &[&str]| {
            for e in examples {
                match STD_ENCODING.decode_without_newline_to_vec(e.as_bytes()) {
                    Ok(buf) => {
                        assert_eq!(expected.as_bytes(), &buf);
                    }
                    Err(err) => {
                        eprintln!("Decode {} failed: {}", e, err);
                        continue;
                    }
                }
            }
        };

        // Each of these should decode to the string "sure", without errors.
        const EXAMPLES: &[&str] = &[
            "ON2XEZI=",
            "ON2XEZI=\r",
            "ON2XEZI=\n",
            "ON2XEZI=\r\n",
            "ON2XEZ\r\nI=",
            "ON2X\rEZ\nI=",
            "ON2X\nEZ\rI=",
            "ON2XEZ\nI=",
            "ON2XEZI\n=",
        ];
        test_string_encode("sure", EXAMPLES);

        // Each of these should decode to the string "foobar", without errors.
        const EXAMPLES1: &[&str] = &["MZXW6YTBOI======", "MZXW6YTBOI=\r\n====="];
        test_string_encode("foobar", EXAMPLES1);
    }

    #[test]
    fn test_decoder_without_newlines() {
        const ENCODED: &str = r"JRXXEZLNEBUXA43VNUQGI33MN5ZCA43JOQQGC3LFOQWCAY3PNZZWKY3UMV2HK4
RAMFSGS4DJONUWG2LOM4QGK3DJOQWCA43FMQQGI3YKMVUXK43NN5SCA5DFNVYG64RANFXGG2LENFSH
K3TUEB2XIIDMMFRG64TFEBSXIIDEN5WG64TFEBWWCZ3OMEQGC3DJOF2WCLRAKV2CAZLONFWQUYLEEB
WWS3TJNUQHMZLONFQW2LBAOF2WS4ZANZXXG5DSOVSCAZLYMVZGG2LUMF2GS33OEB2WY3DBNVRW6IDM
MFRG64TJOMQG42LTNEQHK5AKMFWGS4LVNFYCAZLYEBSWCIDDN5WW233EN4QGG33OONSXC5LBOQXCAR
DVNFZSAYLVORSSA2LSOVZGKIDEN5WG64RANFXAU4TFOBZGK2DFNZSGK4TJOQQGS3RAOZXWY5LQORQX
IZJAOZSWY2LUEBSXG43FEBRWS3DMOVWSAZDPNRXXEZJAMV2SAZTVM5UWC5BANZ2WY3DBBJYGC4TJMF
2HK4ROEBCXQY3FOB2GK5LSEBZWS3TUEBXWGY3BMVRWC5BAMN2XA2LEMF2GC5BANZXW4IDQOJXWSZDF
NZ2CYIDTOVXHIIDJNYFGG5LMOBQSA4LVNEQG6ZTGNFRWSYJAMRSXGZLSOVXHIIDNN5WGY2LUEBQW42
LNEBUWIIDFON2CA3DBMJXXE5LNFY==
====";

        let encoded_start = ENCODED.replace('\n', "");
        let mut dec = STD_ENCODING.decoder_without_newlines(std::io::Cursor::new(&ENCODED));

        let mut res1 = String::new();
        dec.read_to_string(&mut res1).unwrap();

        let mut dec = STD_ENCODING.decoder_without_newlines(std::io::Cursor::new(&encoded_start));
        let mut res2 = String::new();
        dec.read_to_string(&mut res2).unwrap();
        assert_eq!(res1, res2);
    }

    #[test]
    fn test_with_custom_padding() {
        for case in pairs() {
            let default_padding = STD_ENCODING.encode_to_vec(case.decoded.as_bytes());
            let custom_padding = STD_ENCODING
                .with_padding(Some('@'))
                .encode_to_vec(case.decoded.as_bytes());
            let expected = String::from_utf8_lossy(&default_padding).replace('=', "@");

            assert_eq!(expected, String::from_utf8_lossy(&custom_padding));
            assert_eq!(case.encoded.as_bytes(), default_padding);
        }
    }

    #[test]
    fn test_without_padding() {
        for case in pairs() {
            let default_padding = STD_ENCODING.encode_to_vec(case.decoded.as_bytes());
            let custom_padding = STD_ENCODING
                .with_padding(None)
                .encode_to_vec(case.decoded.as_bytes());
            let expected = String::from_utf8_lossy(&default_padding)
                .trim_end_matches('=')
                .to_owned();

            assert_eq!(expected, String::from_utf8_lossy(&custom_padding));
            assert_eq!(case.encoded.as_bytes(), default_padding);
        }
    }

    #[test]
    fn test_decode_with_padding() {
        let encodings = [
            STD_ENCODING,
            STD_ENCODING.with_padding(Some('-')),
            STD_ENCODING.with_padding(None),
        ];

        for enc in encodings {
            for case in pairs() {
                let input = case.decoded.as_bytes();
                let encoded = enc.encode_to_vec(input);

                let decoded = enc.decode_to_vec(&encoded).unwrap();
                assert_eq!(input, &decoded);
            }
        }
    }

    #[test]
    fn test_decode_with_wrong_padding() {
        let encoded = STD_ENCODING.encode_to_vec(b"foobar");

        let _ = STD_ENCODING
            .with_padding(Some('-'))
            .decode_to_vec(&encoded)
            .unwrap_err();

        let _ = STD_ENCODING
            .with_padding(None)
            .decode_to_vec(&encoded)
            .unwrap_err();
    }

    // TODO: implement this
    #[test]
    fn test_buffered_decoding_padding() {}

    // TODO: implement this
    #[test]
    fn test_buffered_decoding_same_error() {}

    #[test]
    fn test_encoded_decoded_len() {
        struct TestCase {
            in_: usize,
            want_enc: usize,
            want_dec: usize,
        }

        struct Test {
            enc: Encoding,
            cases: &'static [TestCase],
        }

        let tests = [
            Test {
                enc: STD_ENCODING,
                cases: &[
                    TestCase {
                        in_: 0,
                        want_enc: 0,
                        want_dec: 0,
                    },
                    TestCase {
                        in_: 1,
                        want_enc: 8,
                        want_dec: 5,
                    },
                    TestCase {
                        in_: 5,
                        want_enc: 8,
                        want_dec: 5,
                    },
                    TestCase {
                        in_: 6,
                        want_enc: 16,
                        want_dec: 10,
                    },
                    TestCase {
                        in_: 10,
                        want_enc: 16,
                        want_dec: 10,
                    },
                ],
            },
            Test {
                enc: STD_ENCODING.with_padding(None),
                cases: &[
                    TestCase {
                        in_: 0,
                        want_enc: 0,
                        want_dec: 0,
                    },
                    TestCase {
                        in_: 1,
                        want_enc: 2,
                        want_dec: 1,
                    },
                    TestCase {
                        in_: 2,
                        want_enc: 4,
                        want_dec: 2,
                    },
                    TestCase {
                        in_: 5,
                        want_enc: 8,
                        want_dec: 5,
                    },
                    TestCase {
                        in_: 6,
                        want_enc: 10,
                        want_dec: 6,
                    },
                    TestCase {
                        in_: 7,
                        want_enc: 12,
                        want_dec: 7,
                    },
                    TestCase {
                        in_: 10,
                        want_enc: 16,
                        want_dec: 10,
                    },
                    TestCase {
                        in_: 11,
                        want_enc: 18,
                        want_dec: 11,
                    },
                ],
            },
        ];

        let data = vec![b'x'; 100];

        for test in tests {
            for tc in test.cases {
                let enc_len = test.enc.encoded_len(tc.in_);
                let dec_len = test.enc.decode_len(enc_len);
                let enc = test.enc.encode_to_vec(&data[..tc.in_]);
                assert_eq!(enc_len, enc.len());
                assert_eq!(enc_len, tc.want_enc);
                assert_eq!(dec_len, tc.want_dec);
            }
        }
    }

    #[test]
    fn test_without_padding_close() {
        let encodings = [STD_ENCODING, STD_ENCODING.with_padding(None)];

        for enc in encodings {
            for case in pairs() {
                let mut buf = Vec::new();
                let mut encoder = enc.encoder(&mut buf);
                let _ = encoder.write(case.decoded.as_bytes()).unwrap();
                encoder.flush().unwrap();

                let mut expected = case.encoded;
                if enc.pad_char.is_none() {
                    expected = expected.replace('=', "");
                }
                assert_eq!(expected.as_bytes(), &buf);
            }
        }
    }

    #[test]
    fn test_decode_read_all() {
        let encodings = [STD_ENCODING, STD_ENCODING.with_padding(None)];

        for pair in pairs() {
            for enc in encodings {
                let mut encoded = pair.encoded.clone();
                if enc.pad_char.is_none() {
                    encoded = encoded.replace('=', "");
                }

                let mut dec = String::new();
                enc.decoder(std::io::Cursor::new(encoded))
                    .read_to_string(&mut dec)
                    .unwrap();

                assert_eq!(pair.decoded, dec);
            }
        }
    }

    #[test]
    fn test_decode_small_buffer() {
        let encodings = [STD_ENCODING, STD_ENCODING.with_padding(None)];

        for buffer_size in 1..200 {
            for pair in pairs() {
                for enc in encodings {
                    let mut encoded = pair.encoded.clone();
                    if enc.pad_char.is_none() {
                        encoded = encoded.replace('=', "");
                    }

                    let mut decoder = enc.decoder(std::io::Cursor::new(encoded));
                    let mut all_read = Vec::new();
                    loop {
                        let mut buf = vec![0; buffer_size];
                        let n = decoder.read(&mut buf).unwrap();
                        if n == 0 {
                            break;
                        }
                        all_read.extend_from_slice(&buf[..n]);
                    }

                    assert_eq!(pair.decoded.as_bytes(), all_read);
                }
            }
        }
    }

    // struct BadReader {
    //     data: Vec<u8>,
    //     called: usize,
    //     errs: Vec<Option<std::io::Error>>,
    //     limit: usize,
    // }

    // impl std::io::Read for BadReader {
    //     fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
    //         let mut lim = buf.len();
    //         if self.limit != 0 && self.limit < lim {
    //             lim = self.limit;
    //         }
    //         if self.data.len() < lim {
    //             lim = self.data.len();
    //         }
    //         let tmp = buf[..lim].to_vec();
    //         for i in tmp {
    //             buf[i as usize] = self.data[i as usize];
    //         }

    //         self.data.drain(..lim);
    //         let mut err = Some(std::io::Error::new(
    //             std::io::ErrorKind::UnexpectedEof,
    //             "bad reader eof",
    //         ));
    //         if self.called < self.errs.len() {
    //             err = self.errs[self.called]
    //                 .as_ref()
    //                 .map(|e| std::io::Error::new(e.kind(), "bad reader"));
    //         }
    //         self.called += 1;
    //         match err {
    //             Some(e) => Err(e),
    //             None => Ok(lim),
    //         }
    //     }
    // }

    // #[test]
    // fn test_decoder_error() {
    //     for err in [
    //         Some(std::io::Error::new(
    //             std::io::ErrorKind::UnexpectedEof,
    //             "test decoder error",
    //         )),
    //         None,
    //     ] {
    //         let input = "MZXW6YTb".to_string();
    //         let mut dbuf = vec![0; STD_ENCODING.decode_len(input.len())];
    //         let mut br = BadReader {
    //             data: input.as_bytes().to_vec(),
    //             called: 0,
    //             errs: vec![err],
    //             limit: 0,
    //         };
    //         let mut decoder = STD_ENCODING.decoder(&mut br);
    //         let n = decoder.read(&mut dbuf).unwrap();
    //         assert_eq!(n, 0);
    //     }
    // }
}