base-encode 0.3.1

Encode and decode data to any base.
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

//! Functions for encoding data into any base from 2 to 256.
//!
//! ## Example
//!
//! ```rust
//! use base_encode::*;
//!
//! let data = vec![0x27, 0x10];
//! encode(&data, 10) // [1, 0, 0, 0, 0]
//! ```
//!
//! Leading zeros are preserved.
//!
//! ```rust
//! encode(&[0, 0, 128], 36) // [0, 0, 3, 14]
//! ```
//!
//! ```rust
//! decode(&[0, 2, 5, 6], 10) // [0, 1, 0]
//! ```
//!
//! ## Encode / decode strings
//!
//! ```rust
//! from_str("255", 10, b"0123456789").unwrap() // [0xff]
//!
//! to_string(&[0xa], 2, b"OX").unwrap() // "XOXO"
//! ```

pub mod utils;

/// Encodes a `u8` slice to any base.
///
/// The `base` must be at least 2 and lower or equal than 256.
///
/// The return value contains the digits in the specified base.
pub fn encode(buf: &[u8], base: u8) -> Vec<u8> {
    let mut num = utils::from_bytes_be(buf);
    let mut digits = Vec::new();

    while num.len() > 1 || num[0] != 0 {
        digits.push(utils::div_rem(&mut num, base as utils::DoubleDigit) as u8);
    }

    let zeros = buf.iter().take_while(|&x| *x == 0).count();

    digits.resize(digits.len() + zeros, 0);
    digits.reverse();
    digits
}

/// Decodes a base encoded `u8` slice into bytes.
///
/// The `base` must be at least 2 and lower or equal than 256.
/// You must ensure that the values are lower that the base.
pub fn decode(buf: &[u8], base: u8) -> Option<Vec<u8>> {
    let mut num = vec![0];
    let zeros = buf.iter().take_while(|&x| *x == 0).count();

    if zeros == buf.len() {
        return Some(vec![0; zeros]);
    }

    for &digit in buf {
        if digit >= base {
            return None;
        }
        utils::mul(&mut num, base as utils::DoubleDigit);
        utils::add(&mut num, digit.into());
    }

    let mut bytes = vec![0; zeros];
    bytes.append(&mut utils::to_bytes_be(&num));
    Some(bytes)
}

/// Converts bytes to a base encoded string using the specified character table.
pub fn to_string(buf: &[u8], base: u8, chars: &[u8]) -> Option<String> {
    encode(buf, base)
        .iter()
        .map(|&x| chars.get(x as usize).map(|&c| c as char))
        .collect()
}

/// Converts a base encoded string to bytes using the specified character table.
pub fn from_str(string: &str, base: u8, chars: &[u8]) -> Option<Vec<u8>> {
    decode(
        &string
            .chars()
            .map(|c| chars.iter().position(|&a| a == c as u8).map(|x| x as u8))
            .collect::<Option<Vec<_>>>()?,
        base,
    )
}