feat: add Base36 encoding

Author: vmx

cli/main.rs

@@ -61,6 +61,8 @@ impl fmt::Display for StrBase {
             Base::Base32PadLower => "base32pad",
             Base::Base32PadUpper => "base32padupper",
             Base::Base32Z => "base32z",
+            Base::Base36Lower => "base36lower",
+            Base::Base36Upper => "base36upper",
             Base::Base58Flickr => "base58flickr",
             Base::Base58Btc => "base58btc",
             Base::Base64 => "base64",
@@ -92,6 +94,8 @@ impl FromStr for StrBase {
             "base32pad" => Ok(Base::Base32PadLower),
             "base32padupper" => Ok(Base::Base32PadUpper),
             "base32z" => Ok(Base::Base32Z),
+            "base36lower" => Ok(Base::Base36Lower),
+            "base36upper" => Ok(Base::Base36Upper),
             "base58flickr" => Ok(Base::Base58Flickr),
             "base58btc" => Ok(Base::Base58Btc),
             "base64" => Ok(Base::Base64),

src/base.rs

@@ -75,6 +75,10 @@ build_base_enum! {
     'T' => Base32HexPadUpper,
     /// z-base-32 (used by Tahoe-LAFS) (alphabet: ybndrfg8ejkmcpqxot1uwisza345h769).
     'h' => Base32Z,
+    /// Base36, [0-9a-z] no padding (alphabet: 0123456789abcdefghijklmnopqrstuvwxyz).
+    'k' => Base36Lower,
+    /// Base36, [0-9A-Z] no padding (alphabet: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ).
+    'K' => Base36Upper,
     /// Base58 flicker (alphabet: 123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ).
     'Z' => Base58Flickr,
     /// Base58 bitcoin (alphabet: 123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz).

src/encoding.rs

@@ -85,6 +85,12 @@ pub const BASE32Z: Encoding = new_encoding! {
     symbols: "ybndrfg8ejkmcpqxot1uwisza345h769",
 };
 
+/// Base36, [0-9a-z] no padding (alphabet: 0123456789abcdefghijklmnopqrstuvwxyz).
+pub const BASE36_LOWER: &str = "0123456789abcdefghijklmnopqrstuvwxyz";
+
+/// Base36, [0-9A-Z] no padding (alphabet: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ).
+pub const BASE36_UPPER: &str = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
+
 // Base58 Flickr's alphabet for creating short urls from photo ids.
 pub const BASE58_FLICKR: &str = "123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ";
 

src/impls.rs

@@ -219,6 +219,38 @@ impl BaseCodec for Base32Z {
     }
 }
 
+/// Base36, [0-9a-z] no padding (alphabet: abcdefghijklmnopqrstuvwxyz0123456789).
+#[derive(PartialEq, Eq, Clone, Copy, Debug)]
+pub(crate) struct Base36Lower;
+
+impl BaseCodec for Base36Lower {
+    fn encode<I: AsRef<[u8]>>(input: I) -> String {
+        base_x::encode(encoding::BASE36_LOWER, input.as_ref())
+    }
+
+    fn decode<I: AsRef<str>>(input: I) -> Result<Vec<u8>> {
+        // The input is case insensitive, hence lowercase it
+        let lowercased = input.as_ref().to_ascii_lowercase();
+        Ok(base_x::decode(encoding::BASE36_LOWER, &lowercased)?)
+    }
+}
+
+/// Base36, [0-9A-Z] no padding (alphabet: ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789).
+#[derive(PartialEq, Eq, Clone, Copy, Debug)]
+pub(crate) struct Base36Upper;
+
+impl BaseCodec for Base36Upper {
+    fn encode<I: AsRef<[u8]>>(input: I) -> String {
+        base_x::encode(encoding::BASE36_UPPER, input.as_ref())
+    }
+
+    fn decode<I: AsRef<str>>(input: I) -> Result<Vec<u8>> {
+        // The input is case insensitive, hence uppercase it
+        let uppercased = input.as_ref().to_ascii_uppercase();
+        Ok(base_x::decode(encoding::BASE36_UPPER, &uppercased)?)
+    }
+}
+
 /// Base58 flicker (alphabet: 123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ).
 #[derive(PartialEq, Eq, Clone, Copy, Debug)]
 pub(crate) struct Base58Flickr;

tests/lib.rs

@@ -56,8 +56,8 @@ fn test_basic() {
         (Base32HexPadLower, "tf5in683dc5n6i811"),
         (Base32HexPadUpper, "TF5IN683DC5N6I811"),
         (Base32Z, "hxf1zgedpcfzg1ebb"),
-        //(Base36Lower, "k2lcpzo5yikidynfl"),
-        //(Base36Upper, "K2LCPZO5YIKIDYNFL"),
+        (Base36Lower, "k2lcpzo5yikidynfl"),
+        (Base36Upper, "K2LCPZO5YIKIDYNFL"),
         (Base58Flickr, "Z7Pznk19XTTzBtx"),
         (Base58Btc, "z7paNL19xttacUY"),
         (Base64, "meWVzIG1hbmkgIQ"),
@@ -87,8 +87,8 @@ fn preserves_leading_zero() {
         (Base32HexPadLower, "t01smasp0dlgmsq9044======"),
         (Base32HexPadUpper, "T01SMASP0DLGMSQ9044======"),
         (Base32Z, "hybhskh3ypiosh4jyrr"),
-        //(Base36Lower, "k02lcpzo5yikidynfl"),
-        //(Base36Upper, "K02LCPZO5YIKIDYNFL"),
+        (Base36Lower, "k02lcpzo5yikidynfl"),
+        (Base36Upper, "K02LCPZO5YIKIDYNFL"),
         (Base58Flickr, "Z17Pznk19XTTzBtx"),
         (Base58Btc, "z17paNL19xttacUY"),
         (Base64, "mAHllcyBtYW5pICE"),
@@ -118,8 +118,8 @@ fn preserves_two_leading_zeroes() {
         (Base32HexPadLower, "t0007ipbj41mm2rj940gg===="),
         (Base32HexPadUpper, "T0007IPBJ41MM2RJ940GG===="),
         (Base32Z, "hyyy813murbssn5ujryoo"),
-        //(Base36Lower, "k002lcpzo5yikidynfl"),
-        //(Base36Upper, "K002LCPZO5YIKIDYNFL"),
+        (Base36Lower, "k002lcpzo5yikidynfl"),
+        (Base36Upper, "K002LCPZO5YIKIDYNFL"),
         (Base58Flickr, "Z117Pznk19XTTzBtx"),
         (Base58Btc, "z117paNL19xttacUY"),
         (Base64, "mAAB5ZXMgbWFuaSAh"),
@@ -145,8 +145,8 @@ fn case_insensitivity() {
         (Base32PadUpper, "Cnbswy3dpeB3W64TMMQ======"),
         (Base32HexPadLower, "td1imor3f41RMUSJCCG======"),
         (Base32HexPadUpper, "Td1imor3f41RMUSJCCG======"),
-        //(Base36Lower, "kfUvrsIvVnfRbjWaJo"),
-        //(Base36Upper, "KfUVrSIVVnFRbJWAJo"),
+        (Base36Lower, "kfUvrsIvVnfRbjWaJo"),
+        (Base36Upper, "KfUVrSIVVnFRbJWAJo"),
     ];
     for (base, output) in test_cases {
         assert_eq!(decode(output).unwrap(), (base, input.to_vec()));