docs

Author: jbesraa

lightning/src/util/base32.rs

@@ -4,13 +4,16 @@ use std::cmp::min;
 
 #[derive(Copy, Clone)]
 pub enum Alphabet {
+    // RFC4648
     RFC4648 { padding: bool },
+    // Crockford
     Crockford,
 }
 
 const RFC4648_ALPHABET: &'static [u8] = b"ABCDEFGHIJKLMNOPQRSTUVWXYZ234567";
 const CROCKFORD_ALPHABET: &'static [u8] = b"0123456789ABCDEFGHJKMNPQRSTVWXYZ";
 
+// Encode a byte slice into a base32 string.
 pub fn encode(alphabet: Alphabet, data: &[u8]) -> String {
     let (alphabet, padding) = match alphabet {
         Alphabet::RFC4648 { padding } => (RFC4648_ALPHABET, padding),
@@ -60,6 +63,7 @@ const CROCKFORD_INV_ALPHABET: [i8; 43] = [
     18, 19, 1, 20, 21, 0, 22, 23, 24, 25, 26, -1, 27, 28, 29, 30, 31,
 ];
 
+// Decode a base32 string into a byte vector.
 pub fn decode(alphabet: Alphabet, data: &str) -> Option<Vec<u8>> {
     if !data.is_ascii() {
         return None;