cj_common 1.2.1

Collection of common functions used by cubicle-jockey projects
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
//! structs, methods and traits for working with b64 encoding/decoding
//!
//! # Quick Start
//!
//!```
//! use cj_common::prelude::*;
//!
//! let s = "Many hands make light work.".to_b64_string();
//! assert_eq!(s.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsu");
//!
//! if let Some(v) = b64_to_bytes("TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsu") {
//!     let r = String::from_utf8_lossy(v.as_slice()).to_string();
//!     assert_eq!(r.as_str(), "Many hands make light work.");
//! }
//!
//! // iter example
//! let mut s = String::new();
//! for c in "Many hands make light work.".iter_to_b64() {
//!     s.push(c);
//! }
//! assert_eq!(s.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsu");
//!
//! let mut v = Vec::new();
//! for b in "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsu".iter_b64_to_byte() {
//!     v.push(b);
//! }
//! let r = String::from_utf8_lossy(v.as_slice()).to_string();
//! assert_eq!(r.as_str(), "Many hands make light work.");
//!
//! // the above are str examples, but it works the same for u8
//! let s = vec![1u8,2,3,4,5,6].to_b64_string();
//! let iter = [1u8,2,3,4,5,6].as_slice().iter_to_b64();
//! ```

use std::slice::Iter;
use std::str::Chars;

// general b64 table (RFC 4648.4).
const B64_TABLE: [char; 64] = [
    'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S',
    'T', 'U', 'V', 'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l',
    'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4',
    '5', '6', '7', '8', '9', '+', '/',
];

#[derive(Debug)]
#[repr(u8)]
pub enum CharToOrdResult {
    Ok(u8),
    Pad,
    WhiteSpace,
    Invalid,
}

impl CharToOrdResult {
    #[inline]
    pub const fn is_ok(&self) -> bool {
        matches!(self, CharToOrdResult::Ok(_))
    }
    #[inline]
    pub const fn is_padding(&self) -> bool {
        matches!(self, CharToOrdResult::Pad)
    }
    #[inline]
    pub const fn is_whitespace(&self) -> bool {
        matches!(self, CharToOrdResult::WhiteSpace)
    }
    #[inline]
    pub const fn is_invalid(&self) -> bool {
        matches!(self, CharToOrdResult::Invalid)
    }
}

#[inline]
pub const fn b64_char_to_ord(c: &char) -> &'static CharToOrdResult {
    match c {
        'A' => &CharToOrdResult::Ok(0),
        'B' => &CharToOrdResult::Ok(1),
        'C' => &CharToOrdResult::Ok(2),
        'D' => &CharToOrdResult::Ok(3),
        'E' => &CharToOrdResult::Ok(4),
        'F' => &CharToOrdResult::Ok(5),
        'G' => &CharToOrdResult::Ok(6),
        'H' => &CharToOrdResult::Ok(7),
        'I' => &CharToOrdResult::Ok(8),
        'J' => &CharToOrdResult::Ok(9),
        'K' => &CharToOrdResult::Ok(10),
        'L' => &CharToOrdResult::Ok(11),
        'M' => &CharToOrdResult::Ok(12),
        'N' => &CharToOrdResult::Ok(13),
        'O' => &CharToOrdResult::Ok(14),
        'P' => &CharToOrdResult::Ok(15),
        'Q' => &CharToOrdResult::Ok(16),
        'R' => &CharToOrdResult::Ok(17),
        'S' => &CharToOrdResult::Ok(18),
        'T' => &CharToOrdResult::Ok(19),
        'U' => &CharToOrdResult::Ok(20),
        'V' => &CharToOrdResult::Ok(21),
        'W' => &CharToOrdResult::Ok(22),
        'X' => &CharToOrdResult::Ok(23),
        'Y' => &CharToOrdResult::Ok(24),
        'Z' => &CharToOrdResult::Ok(25),
        'a' => &CharToOrdResult::Ok(26),
        'b' => &CharToOrdResult::Ok(27),
        'c' => &CharToOrdResult::Ok(28),
        'd' => &CharToOrdResult::Ok(29),
        'e' => &CharToOrdResult::Ok(30),
        'f' => &CharToOrdResult::Ok(31),
        'g' => &CharToOrdResult::Ok(32),
        'h' => &CharToOrdResult::Ok(33),
        'i' => &CharToOrdResult::Ok(34),
        'j' => &CharToOrdResult::Ok(35),
        'k' => &CharToOrdResult::Ok(36),
        'l' => &CharToOrdResult::Ok(37),
        'm' => &CharToOrdResult::Ok(38),
        'n' => &CharToOrdResult::Ok(39),
        'o' => &CharToOrdResult::Ok(40),
        'p' => &CharToOrdResult::Ok(41),
        'q' => &CharToOrdResult::Ok(42),
        'r' => &CharToOrdResult::Ok(43),
        's' => &CharToOrdResult::Ok(44),
        't' => &CharToOrdResult::Ok(45),
        'u' => &CharToOrdResult::Ok(46),
        'v' => &CharToOrdResult::Ok(47),
        'w' => &CharToOrdResult::Ok(48),
        'x' => &CharToOrdResult::Ok(49),
        'y' => &CharToOrdResult::Ok(50),
        'z' => &CharToOrdResult::Ok(51),
        '0' => &CharToOrdResult::Ok(52),
        '1' => &CharToOrdResult::Ok(53),
        '2' => &CharToOrdResult::Ok(54),
        '3' => &CharToOrdResult::Ok(55),
        '4' => &CharToOrdResult::Ok(56),
        '5' => &CharToOrdResult::Ok(57),
        '6' => &CharToOrdResult::Ok(58),
        '7' => &CharToOrdResult::Ok(59),
        '8' => &CharToOrdResult::Ok(60),
        '9' => &CharToOrdResult::Ok(61),
        '+' => &CharToOrdResult::Ok(62),
        '/' => &CharToOrdResult::Ok(63),
        '=' => &CharToOrdResult::Pad,
        // chars to ignore
        ' ' => &CharToOrdResult::WhiteSpace,
        '\r' => &CharToOrdResult::WhiteSpace,
        '\n' => &CharToOrdResult::WhiteSpace,
        '\t' => &CharToOrdResult::WhiteSpace,
        // all else are failures
        _ => &CharToOrdResult::Invalid,
    }
}

#[derive(Debug, PartialOrd, PartialEq, Ord, Eq)]
#[repr(u8)]
enum BitSplit6Result {
    Ready,
    Resend,
}

#[inline(always)]
fn bit_split_6(src: &u8, b6: &mut u8, br: &mut u8, pass_of: &mut usize) -> BitSplit6Result {
    // iter  bytes (it requires 4 bytes, per 3 bytes in)
    // -     11111111 22222222 33333333 00000000 (start)
    // 0     XX111111 11222222 22333333 33000000
    // 1     XXXX1111 11112222 22223333 33330000
    // 2     XXXXXX11 11111122 22222233 33333300
    // 3     XXXXXXXX 11111111 22222222 33333333
    match pass_of {
        0 => {
            // take 6 from src
            *b6 = src >> 2;
            // two remaining
            *br = src << 6;
            *pass_of += 1;

            BitSplit6Result::Ready
        }
        1 => {
            // take two remaining
            *b6 = *br >> 2;
            // plus 4 from src
            *b6 += src >> 4;
            // four remaining
            *br = src << 4;
            *pass_of += 1;

            BitSplit6Result::Ready
        }
        2 => {
            // take four remaining
            *b6 = *br >> 2;
            // plus two from src
            *b6 += src >> 6;
            // six remaining
            *br = src << 2;
            *pass_of += 1;

            BitSplit6Result::Ready
        }
        3 => {
            // take 6 remaining
            *b6 = *br >> 2;
            *pass_of = 0;

            BitSplit6Result::Resend
        }
        _ => {
            *pass_of = 0;
            //println!("huh? not expected here");
            BitSplit6Result::Resend
        }
    }
}

///
/// converts a slice of bytes into a base64 encoded string
///
/// ```
///  # use crate::cj_common::prelude::bytes_to_b64;
///
/// let s = "Many hands make light work.".as_bytes();
/// let s2 = bytes_to_b64(s);
/// assert_eq!(s2.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsu");
/// ```
pub fn bytes_to_b64(bytes: &[u8]) -> String {
    let mut s = String::with_capacity((bytes.len() as f64 * 1.25) as usize + 2);

    let mut b_six = 0u8;
    let mut b_rem = 0u8;
    let mut pass_no = 0usize;
    let b_len = bytes.len();
    let mut s_char_ct = 0;

    for b in bytes[..].iter() {
        match bit_split_6(b, &mut b_six, &mut b_rem, &mut pass_no) {
            BitSplit6Result::Ready => {
                s.push(B64_TABLE[b_six as usize]);
                s_char_ct += 1;
            }
            BitSplit6Result::Resend => {
                s.push(B64_TABLE[b_six as usize]);
                let _ = bit_split_6(b, &mut b_six, &mut b_rem, &mut pass_no);
                s.push(B64_TABLE[b_six as usize]);
                s_char_ct += 2;
            }
        }
    }

    if b_len > 0 {
        let x = b_rem;
        b_rem = 0;
        pass_no = 0;
        let _ = bit_split_6(&x, &mut b_six, &mut b_rem, &mut pass_no);
        s.push(B64_TABLE[b_six as usize]);
        s_char_ct += 1;
    }

    while ((s_char_ct * 6) % 8) != 0 {
        s.push('=');
        s_char_ct += 1;
    }
    s
}

///
/// Iterator for a slice of bytes that returns Base64
///
/// ```
///  # use cj_common::prelude::CjToBase64Iter;
///  # use crate::cj_common::prelude::ToBase64Iter;
/// // slice of bytes example
/// let s = "Many hands make light work.".as_bytes();
/// let mut s2 = String::new();
/// for c in s.iter_to_b64() {
///     s2.push(c);
/// }
/// assert_eq!(s2.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsu");
///
/// // vec of bytes example
/// let s = "Many hands make light work.".as_bytes().to_vec();
/// let mut s2 = String::new();
///
/// for c in s.iter_to_b64() {
///     s2.push(c);
/// }
/// assert_eq!(s2.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsu");
/// ```
pub struct ToBase64Iter<'a> {
    six_bits: u8,
    rem_bits: u8,
    pass_no: usize,
    char_count: usize,
    push_last: bool,
    pend_char: Option<char>,
    inner: Iter<'a, u8>,
}

impl<'a> ToBase64Iter<'a> {
    pub fn new(i: Iter<'a, u8>) -> Self {
        Self {
            six_bits: 0,
            rem_bits: 0,
            pass_no: 0,
            pend_char: None,
            char_count: 0,
            push_last: true,
            inner: i,
        }
    }
    #[inline]
    fn next_char(&mut self) -> Option<char> {
        if let Some(c) = self.pend_char {
            self.pend_char = None;
            Some(c)
        } else {
            if let Some(b) = &self.inner.next() {
                let c: char;
                match bit_split_6(b, &mut self.six_bits, &mut self.rem_bits, &mut self.pass_no) {
                    BitSplit6Result::Ready => {
                        c = B64_TABLE[self.six_bits as usize];
                        self.char_count += 1;
                    }
                    BitSplit6Result::Resend => {
                        c = B64_TABLE[self.six_bits as usize];
                        let _ = bit_split_6(
                            b,
                            &mut self.six_bits,
                            &mut self.rem_bits,
                            &mut self.pass_no,
                        );
                        self.pend_char = Some(B64_TABLE[self.six_bits as usize]);
                        self.char_count += 2;
                    }
                }
                return Some(c);
            } else if self.char_count > 0 {
                if self.push_last {
                    let x = self.rem_bits;
                    self.rem_bits = 0;
                    self.pass_no = 0;
                    let _ = bit_split_6(
                        &x,
                        &mut self.six_bits,
                        &mut self.rem_bits,
                        &mut self.pass_no,
                    );
                    self.char_count += 1;
                    self.push_last = false;
                    return Some(B64_TABLE[self.six_bits as usize]);
                } else if ((self.char_count * 6) % 8) != 0 {
                    self.char_count += 1;
                    return Some('=');
                }
            }
            None
        }
    }
}

impl Iterator for ToBase64Iter<'_> {
    type Item = char;

    fn next(&mut self) -> Option<Self::Item> {
        self.next_char()
    }
}

pub trait CjToBase64Iter {
    fn iter_to_b64(&self) -> ToBase64Iter<'_>;
}

impl CjToBase64Iter for &[u8] {
    /// Iterator for a slice of bytes that produces Base64 encoded chars
    /// ```
    /// # use cj_common::prelude::CjToBase64Iter;
    /// let s = "Many hands make light work.".as_bytes();
    /// let mut s2 = String::new();
    /// for c in s.iter_to_b64() {
    ///     s2.push(c);
    /// }
    /// assert_eq!(s2.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsu");
    /// ```
    fn iter_to_b64(&self) -> ToBase64Iter<'_> {
        ToBase64Iter::new(self[..].iter())
    }
}

impl CjToBase64Iter for &str {
    /// Iterator for str that produces Base64 encoded chars
    /// ```
    /// # use cj_common::prelude::CjToBase64Iter;
    /// let mut s2 = String::new();
    /// for c in "Many hands make light work.".iter_to_b64() {
    ///     s2.push(c);
    /// }
    /// assert_eq!(s2.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsu");
    /// ```
    fn iter_to_b64(&self) -> ToBase64Iter<'_> {
        ToBase64Iter::new(self.as_bytes()[..].iter())
    }
}

impl CjToBase64Iter for Vec<u8> {
    /// Iterator for a `Vec<u8>` that produces Base64 encoded chars
    /// ```
    /// # use cj_common::prelude::CjToBase64Iter;
    /// let s = Vec::<u8>::from("Many hands make light work.");
    /// let mut s2 = String::new();
    /// for c in s.iter_to_b64() {
    ///     s2.push(c);
    /// }
    /// assert_eq!(s2.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsu");
    /// ```
    fn iter_to_b64(&self) -> ToBase64Iter<'_> {
        ToBase64Iter::new(self[..].iter())
    }
}

///
/// Iterator for a Base64 encoded str that returns decoded byte
///
/// ```
///  # use cj_common::prelude::{CjFromBase64Iter,FromBase64Iter};
/// // slice of bytes example
/// let mut v = Vec::new();
/// for b in "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsu".iter_b64_to_byte() {
///     v.push(b);
/// }
/// assert!(v.len() > 0);
/// let r = String::from_utf8_lossy(v.as_slice());
/// let s = "Many hands make light work.";
/// assert_eq!(r.to_string().as_str(), s);
/// ```
pub struct FromBase64Iter<'a> {
    buf_left: u8,
    buf_ct: u8,
    had_pad: bool,
    total_added: usize,
    inner: Chars<'a>,
}

impl<'a> FromBase64Iter<'a> {
    pub fn new(i: Chars<'a>) -> Self {
        Self {
            buf_left: 0,
            buf_ct: 0,
            had_pad: false,
            total_added: 0,
            inner: i,
        }
    }

    // fn new_adapter(i: Chars) -> Self {
    //     Self {
    //         buf_left: 0,
    //         buf_ct: 0,
    //         had_pad: false,
    //         total_added: 0,
    //         inner: i,
    //     }
    // }
    #[inline]
    fn next_byte(&mut self) -> Option<u8> {
        let return_b: u8;
        while let Some(c) = &self.inner.next() {
            let r = b64_char_to_ord(c);
            match r {
                CharToOrdResult::Ok(b) => {
                    if self.had_pad {
                        break;
                    }
                    match self.buf_ct {
                        0 => {
                            // buf_left is empty
                            // drop two bits from 'b' and take 6
                            // 00XXXXXX
                            self.buf_left = b << 2;
                            self.buf_ct += 1;
                        }
                        1 => {
                            // buf_left has 6 bits XXXXXX00
                            // drop two bits from 'b' and take 2
                            self.buf_left += (b << 2) >> 6;
                            // push the complete byte
                            return_b = self.buf_left;
                            // now take the remaining 4
                            self.buf_left = b << 4;
                            self.buf_ct += 1;
                            self.total_added += 1;
                            return Some(return_b);
                        }
                        2 => {
                            // buf_left has 4 bits XXXX0000
                            // drop two bits from 'b' and take 4
                            self.buf_left += (b << 2) >> 4;
                            // push the complete byte
                            return_b = self.buf_left;
                            self.buf_left = b << 6;
                            self.buf_ct += 1;
                            self.total_added += 1;
                            return Some(return_b);
                        }
                        3 => {
                            // buf_left has 2 bits XX000000
                            // 'b' only has 6 bits. take them all
                            self.buf_left += b;
                            // push the complete byte
                            return_b = self.buf_left;
                            self.buf_ct = 0;
                            self.total_added += 1;
                            return Some(return_b);
                        }
                        _ => unreachable!(),
                    }
                }
                CharToOrdResult::Pad => self.had_pad = true,
                CharToOrdResult::WhiteSpace => {
                    if self.had_pad {
                        break;
                    }
                }
                CharToOrdResult::Invalid => {
                    return None;
                }
            }
        }

        if self.total_added > 0 && (self.buf_ct != 0) && (!self.had_pad) {
            return Some(self.buf_left);
        }

        None
    }
}

impl Iterator for FromBase64Iter<'_> {
    type Item = u8;

    fn next(&mut self) -> Option<Self::Item> {
        self.next_byte()
    }
}

pub trait CjFromBase64Iter {
    fn iter_b64_to_byte(&self) -> FromBase64Iter<'_>;
}

impl CjFromBase64Iter for &str {
    /// Iterator for decoding a Base64 endoced str to bytes
    /// ```
    /// # use cj_common::prelude::CjFromBase64Iter;
    /// let mut v = Vec::new();
    /// for b in "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsu".iter_b64_to_byte() {
    ///     v.push(b);
    /// }
    /// assert!(v.len() > 0);
    /// let r = String::from_utf8_lossy(v.as_slice());
    /// let s = "Many hands make light work.";
    /// assert_eq!(r.to_string().as_str(), s);
    /// ```
    fn iter_b64_to_byte(&self) -> FromBase64Iter<'_> {
        FromBase64Iter::new(self.chars())
    }
}

/// converts a Base64 encoded str into a vec of bytes
/// ```
/// # use cj_common::prelude::b64_to_bytes;
/// let v = b64_to_bytes("TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsu");
/// assert!(v.is_some());
/// if let Some(x) = v {
///    let s = "Many hands make light work.".as_bytes().to_vec();
///    assert_eq!(x, s);
/// }
/// ```
pub fn b64_to_bytes(data: &str) -> Option<Vec<u8>> {
    let mut v = Vec::<u8>::with_capacity((data.len() as f64 * 0.8) as usize);
    let mut buf_left = 0u8;
    let mut buf_ct = 0usize;
    let mut had_pad = false;
    //let mut had_error = false;
    let mut total_added = 0usize;
    for c in data.chars() {
        let r = b64_char_to_ord(&c);
        match r {
            CharToOrdResult::Ok(b) => {
                if had_pad {
                    break;
                }
                match buf_ct {
                    0 => {
                        // buf_left is empty
                        // drop two bits from 'b' and take 6
                        // 00XXXXXX
                        buf_left = b << 2;
                        buf_ct += 1;
                    }
                    1 => {
                        // buf_left has 6 bits XXXXXX00
                        // drop two bits from 'b' and take 2
                        buf_left += (b << 2) >> 6;
                        // push the complete byte
                        v.push(buf_left);
                        // now take the remaining 4
                        buf_left = b << 4;
                        buf_ct += 1;
                        total_added += 1;
                    }
                    2 => {
                        // buf_left has 4 bits XXXX0000
                        // drop two bits from 'b' and take 4
                        buf_left += (b << 2) >> 4;
                        // push the complete byte
                        v.push(buf_left);
                        buf_left = b << 6;
                        buf_ct += 1;
                        total_added += 1;
                    }
                    3 => {
                        // buf_left has 2 bits XX000000
                        // 'b' only has 6 bits. take them all
                        buf_left += b;
                        // push the complete byte
                        v.push(buf_left);
                        buf_ct = 0;
                        total_added += 1;
                    }
                    _ => unreachable!(),
                }
            }
            CharToOrdResult::Pad => had_pad = true,
            CharToOrdResult::WhiteSpace => {
                if had_pad {
                    break;
                }
            }
            CharToOrdResult::Invalid => {
                //had_error = true;
                break;
            }
        }
    }

    if total_added > 0 {
        if (buf_ct != 0) && (!had_pad) {
            v.push(buf_left);
        }
        // we were able to decode something, even if there was an error. return what we have.
        return Some(v);
    }

    None
}

pub trait CjToBase64 {
    fn to_b64_string(&self) -> String;
}

impl CjToBase64 for &str {
    /// converts str to Base64 encoded String
    /// ```
    /// # use cj_common::prelude::CjToBase64;
    /// let s = "Many hands make light work...8675";
    /// let s2 = s.to_b64_string();
    /// println!("{}", s2);
    /// assert_eq!(s2.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsuLi44Njc1");
    /// ```
    fn to_b64_string(&self) -> String {
        bytes_to_b64(self.as_bytes())
    }
}

impl CjToBase64 for String {
    /// converts String to Base64 encoded String
    /// ```
    /// # use cj_common::prelude::CjToBase64;
    /// let s = String::from("Many hands make light work...8675");
    /// let s2 = s.to_b64_string();
    /// println!("{}", s2);
    /// assert_eq!(s2.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsuLi44Njc1");
    /// ```
    fn to_b64_string(&self) -> String {
        bytes_to_b64(self.as_bytes())
    }
}

impl CjToBase64 for Vec<u8> {
    /// converts `Vec<u8>` to Base64 encoded String
    /// ```
    /// # use cj_common::prelude::CjToBase64;
    /// let s = Vec::<u8>::from("Many hands make light work...8675");
    /// let s2 = s.to_b64_string();
    /// println!("{}", s2);
    /// assert_eq!(s2.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsuLi44Njc1");
    /// ```
    fn to_b64_string(&self) -> String {
        bytes_to_b64(self.as_slice())
    }
}

#[cfg(test)]
mod test {
    use crate::cj_binary::b64::*;

    #[test]
    fn test_1() {
        let s = "Many hands make light work.".as_bytes();
        let s2 = bytes_to_b64(s);
        assert_eq!(s2.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsu");
    }

    #[test]
    fn test_2() {
        let s = "Many hands make light work..".as_bytes();
        let s2 = bytes_to_b64(s);
        println!("{}", s2);
        assert_eq!(s2.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsuLg==");
    }

    #[test]
    fn test_3() {
        let s = "Many hands make light work...".as_bytes();
        let s2 = bytes_to_b64(s);
        println!("{}", s2);
        assert_eq!(s2.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsuLi4=");
    }

    #[test]
    fn test_4() {
        let s = "Many hands make light work...8675".as_bytes();
        let s2 = bytes_to_b64(s);
        println!("{}", s2);
        assert_eq!(s2.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsuLi44Njc1");
    }

    #[test]
    fn test_5() {
        let s = "Many hands make light work...8675";
        let s2 = s.to_b64_string();
        println!("{}", s2);
        assert_eq!(s2.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsuLi44Njc1");
    }

    #[test]
    fn test_6() {
        let s = String::from("Many hands make light work...8675");
        let s2 = s.to_b64_string();
        println!("{}", s2);
        assert_eq!(s2.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsuLi44Njc1");
    }

    #[test]
    fn test_7() {
        let s = Vec::<u8>::from("Many hands make light work...8675");
        let s2 = s.to_b64_string();
        println!("{}", s2);
        assert_eq!(s2.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsuLi44Njc1");
    }

    #[test]
    fn test_iter_1() {
        let s = "Many hands make light work.".as_bytes();
        let mut s2 = String::new();

        for c in s.iter_to_b64() {
            s2.push(c);
        }
        assert_eq!(s2.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsu");
    }

    #[test]
    fn test_iter_2() {
        let s = "Many hands make light work.".as_bytes().to_vec();
        let mut s2 = String::new();

        for c in s.iter_to_b64() {
            s2.push(c);
        }
        assert_eq!(s2.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsu");
    }

    #[test]
    fn test_iter_3() {
        let mut s2 = String::new();
        for c in "Many hands make light work.".iter_to_b64() {
            s2.push(c);
        }
        assert_eq!(s2.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsu");
    }

    #[test]
    fn test_from_b64_1() {
        let v = b64_to_bytes("TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsu");
        assert!(v.is_some());
        if let Some(x) = v {
            let s = "Many hands make light work.".as_bytes().to_vec();
            assert_eq!(x, s);
        }
    }

    #[test]
    fn test_from_b64_2() {
        let v = b64_to_bytes("TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsuLg==");
        assert!(v.is_some());
        if let Some(x) = v {
            let s = "Many hands make light work..".as_bytes().to_vec();
            assert_eq!(x, s);
        }
    }

    #[test]
    fn test_from_b64_3() {
        let v = b64_to_bytes("TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsuLi4=");
        assert!(v.is_some());
        if let Some(x) = v {
            let s = "Many hands make light work...".as_bytes().to_vec();
            assert_eq!(x, s);
        }
    }

    #[test]
    fn test_from_b64_4() {
        let v = b64_to_bytes("TWFueSBoYW5kcyBtYWtl   IGxpZ2h0IHdvcmsuLi4=");
        assert!(v.is_some());
        if let Some(x) = v {
            let s = "Many hands make light work...".as_bytes().to_vec();
            assert_eq!(x, s);
        }
    }

    #[test]
    fn test_from_b64_5() {
        let v = b64_to_bytes("TWFueSBoYW5kcyBtYWtl   IGxpZ2h0IHdvcmsuLi4=nope");
        assert!(v.is_some());
        if let Some(x) = v {
            let s = "Many hands make light work...".as_bytes().to_vec();
            assert_eq!(x, s);
        }
    }

    #[test]
    fn test_from_b64_6() {
        let v = b64_to_bytes("TWFueSBoYW5kcyBtYWtl   IGxpZ2h0IHdvcmsuLi4=&");
        assert!(v.is_some());
        if let Some(x) = v {
            let s = "Many hands make light work...".as_bytes().to_vec();
            assert_eq!(x, s);
        }
    }

    #[test]
    fn test_from_b64_iter_1() {
        let mut v = Vec::new();
        for b in "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsu".iter_b64_to_byte() {
            v.push(b);
        }
        assert!(!v.is_empty());
        let r = String::from_utf8_lossy(v.as_slice());
        let s = "Many hands make light work.";
        assert_eq!(r.to_string().as_str(), s);
    }

    #[test]
    fn test_from_b64_iter_2() {
        let mut v = Vec::new();
        for b in "TWFueSBoYW5kcyBtYWtl   IGxpZ2h0IHdvcmsuLi4=&".iter_b64_to_byte() {
            v.push(b);
        }
        assert!(!v.is_empty());
        let r = String::from_utf8_lossy(v.as_slice());
        let s = "Many hands make light work...";
        assert_eq!(r.to_string().as_str(), s);
    }

    #[test]
    fn test_b64_docs() {
        let mut s2 = String::new();
        for c in "Many hands make light work.".iter_to_b64() {
            s2.push(c);
        }
        assert_eq!(s2.as_str(), "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsu");
        //
        let mut v = Vec::new();
        for b in "TWFueSBoYW5kcyBtYWtlIGxpZ2h0IHdvcmsu".iter_b64_to_byte() {
            v.push(b);
        }
        assert!(!v.is_empty());
        let r = String::from_utf8_lossy(v.as_slice());
        let s = "Many hands make light work.";
        assert_eq!(r.to_string().as_str(), s);
    }
}