Update comments for new returns on padded decodes, and link from unpa…

…dded capacity fns

src/base32/alphabet.rs

@@ -229,6 +229,8 @@ impl Alphabet32Padded {
     }
 
     /// Pass decoder array to [`decode`](super::decode()), and remove padding as needed
+    ///
+    /// Also returns [`DecodeError`] if input is an invalid length for padding (i.e. not a multiple of 8)
     #[inline]
     pub fn decode(&self, a: &[u8]) -> Result<Vec<u8>, DecodeError> {
         if a.len() % WIDTH_ENC != 0 {
@@ -239,6 +241,8 @@ impl Alphabet32Padded {
     }
 
     /// Pass decoder array to [`decode_into`](super::decode_into()), and remove padding as needed
+    ///
+    /// Also returns [`DecodeError`] if input is an invalid length for padding (i.e. not a multiple of 8)
     #[inline]
     pub fn decode_into(&self, a: &[u8], b: &mut Vec<u8>) -> Result<(), DecodeError> {
         if a.len() % WIDTH_ENC != 0 {
@@ -249,6 +253,8 @@ impl Alphabet32Padded {
     }
 
     /// Pass string as bytes and decoder array to [`decode`](super::decode()), and remove padding as needed
+    ///
+    /// Also returns [`DecodeError`] if input is an invalid length for padding (i.e. not a multiple of 8)
     #[inline]
     pub fn decode_str(&self, a: impl AsRef<str>) -> Result<Vec<u8>, DecodeError> {
         let a = a.as_ref().as_bytes();

src/base32/decode_bytes.rs

@@ -5,6 +5,8 @@ use crate::shared::{bits_or_err_u8, DecodeError};
 use super::alphabet::{WIDTH_DEC, WIDTH_ENC};
 
 /// Capacity needed in dest `Vec<u8>` to decode this byte array -- without padding!
+///
+/// Also see padded [`capacity_decode`](super::Alphabet32Padded::capacity_decode())
 #[inline]
 pub const fn capacity_decode(a: &[u8]) -> usize {
     a.len() * WIDTH_DEC / WIDTH_ENC

src/base32/encode_bytes.rs

@@ -9,6 +9,8 @@ const U8_MASK_MID_2: u8 = 0b01111100;
 const U8_MASK_MID_1: u8 = 0b00111110;
 
 /// Capacity needed in dest `Vec<u8>` to encode this byte array -- without padding!
+///
+/// Also see padded [`capacity_encode`](super::Alphabet32Padded::capacity_encode())
 #[inline]
 pub const fn capacity_encode(a: &[u8]) -> usize {
     // https://stackoverflow.com/questions/23636240/how-do-i-predict-the-required-size-of-a-base32-decode-output

src/base64/alphabet.rs

@@ -180,6 +180,8 @@ impl Alphabet64Padded {
     }
 
     /// Pass decoder array to [`decode`](super::decode()), and remove padding as needed
+    ///
+    /// Also returns [`DecodeError`] if input is an invalid length for padding (i.e. not a multiple of 4)
     #[inline]
     pub fn decode(&self, a: &[u8]) -> Result<Vec<u8>, DecodeError> {
         if a.len() % WIDTH_ENC != 0 {
@@ -190,6 +192,8 @@ impl Alphabet64Padded {
     }
 
     /// Pass decoder array to [`decode_into`](super::decode_into()), and remove padding as needed
+    ///
+    /// Also returns [`DecodeError`] if input is an invalid length for padding (i.e. not a multiple of 4)
     #[inline]
     pub fn decode_into(&self, a: &[u8], b: &mut Vec<u8>) -> Result<(), DecodeError> {
         if a.len() % WIDTH_ENC != 0 {
@@ -200,6 +204,8 @@ impl Alphabet64Padded {
     }
 
     /// Pass string as bytes and decoder array to [`decode`](super::decode()), and remove padding as needed
+    ///
+    /// Also returns [`DecodeError`] if input is an invalid length for padding (i.e. not a multiple of 4)
     #[inline]
     pub fn decode_str(&self, a: impl AsRef<str>) -> Result<Vec<u8>, DecodeError> {
         let a = a.as_ref().as_bytes();

src/base64/decode_bytes.rs

@@ -5,6 +5,8 @@ use crate::shared::{bits_or_err_u8, DecodeError};
 use super::alphabet::{WIDTH_DEC, WIDTH_ENC};
 
 /// Capacity needed in dest `Vec<u8>` to decode this byte array -- without padding!
+///
+/// Also see padded [`capacity_decode`](super::Alphabet64Padded::capacity_decode())
 #[inline]
 pub const fn capacity_decode(a: &[u8]) -> usize {
     a.len() * WIDTH_DEC / WIDTH_ENC

src/base64/encode_bytes.rs

@@ -6,6 +6,8 @@ use crate::shared::*;
 use super::alphabet::{BITS, WIDTH_DEC, WIDTH_ENC};
 
 /// Capacity needed in dest `Vec<u8>` to encode this byte array -- without padding!
+///
+/// Also see padded [`capacity_encode`](super::Alphabet64Padded::capacity_encode())
 #[inline]
 pub const fn capacity_encode(a: &[u8]) -> usize {
     // https://stackoverflow.com/questions/23636240/how-do-i-predict-the-required-size-of-a-base32-decode-output