radix64 0.6.2

A base64 library by another name
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

use crate::u6::U6;
use crate::Config;

pub(crate) mod block;
pub(crate) mod io;

pub(crate) fn encode_slice<C>(config: C, mut input: &[u8], mut output: &mut [u8]) -> usize
where
    C: Config,
{
    let (input_idx, output_idx) = encode_full_chunks_without_padding(config, input, output);
    input = &input[input_idx..];
    output = &mut output[output_idx..];

    output_idx + encode_partial_chunk(config, input, output)
}

#[inline]
pub(crate) fn encode_full_chunks_without_padding<C>(
    config: C,
    mut input: &[u8],
    mut output: &mut [u8],
) -> (usize, usize)
where
    C: Config,
{
    use crate::encode::block::BlockEncoder;
    let (full_block_input_idx, full_block_output_idx) = if input.len() < 32 {
        (0, 0)
    } else {
        // If input is suitably large use an architecture optimized encoder.
        let block_encoder = config.into_block_encoder();
        block_encoder.encode_blocks(input, output)
    };
    input = &input[full_block_input_idx..];
    output = &mut output[full_block_output_idx..];

    // Encode the remaining non-padding 3 byte chunks of input.
    let mut iter = EncodeIter::new(input, output);
    while let Some((input, output)) = iter.next_chunk() {
        encode_chunk(config, *input, output);
    }
    let (chunk_input_idx, chunk_output_idx) = iter.remaining();
    (
        full_block_input_idx + chunk_input_idx,
        full_block_output_idx + chunk_output_idx,
    )
}

#[inline]
pub(crate) fn encode_partial_chunk<C>(config: C, input: &[u8], output: &mut [u8]) -> usize
where
    C: Config,
{
    match input.len() {
        0 => 0,
        1 => {
            output[0] = config.encode_u6(U6::from_low_six_bits(input[0] >> 2));
            output[1] = config.encode_u6(U6::from_low_six_bits(input[0] << 4));
            if let Some(padding) = config.padding_byte() {
                output[2] = padding;
                output[3] = padding;
                4
            } else {
                2
            }
        }
        2 => {
            output[0] = config.encode_u6(U6::from_low_six_bits(input[0] >> 2));
            output[1] = config.encode_u6(U6::from_low_six_bits(input[0] << 4 | input[1] >> 4));
            output[2] = config.encode_u6(U6::from_low_six_bits(input[1] << 2));
            if let Some(padding) = config.padding_byte() {
                output[3] = padding;
                4
            } else {
                3
            }
        }
        _ => panic!("invalid input remaining. Is the output buffer too small?"),
    }
}

fn encode_chunk<C: Config>(config: C, input: [u8; 3], output: &mut [u8; 4]) {
    output[0] = config.encode_u6(U6::from_low_six_bits(input[0] >> 2));
    output[1] = config.encode_u6(U6::from_low_six_bits(input[0] << 4 | input[1] >> 4));
    output[2] = config.encode_u6(U6::from_low_six_bits(input[1] << 2 | input[2] >> 6));
    output[3] = config.encode_u6(U6::from_low_six_bits(input[2]));
}

#[inline]
pub(crate) fn encode_using_table(table: &[u8; 64], input: U6) -> u8 {
    let idx: usize = input.into();
    // No need to do bounds checking because a U6 is guaranteed to only contain 0-63
    let encoded = unsafe { table.get_unchecked(idx) };
    *encoded
}

define_block_iter!(
    name = EncodeIter,
    input_chunk_size = 3,
    input_stride = 3,
    output_chunk_size = 4,
    output_stride = 4
);

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn encode_slice_panics_on_short_output_slice() {
        let did_panic = std::panic::catch_unwind(|| {
            let mut output = vec![0; 1];
            encode_slice(crate::STD, "aaaa".as_ref(), output.as_mut_slice());
        })
        .is_err();
        assert!(did_panic);
    }
}