use super::{alphabet::B64_ALPHABET, alphabet::b64_byte_to_index, error::Error};
#[cfg(feature = "alloc")]
#[allow(
unused_imports,
reason = "alloc prelude items; subset used per cfg/feature combination"
)]
use alloc::string::String;
use core::num::NonZeroUsize;
use num_traits::{AsPrimitive, PrimInt, ops::checked::CheckedShl, sign::Unsigned};
#[allow(
clippy::as_conversions,
clippy::cast_possible_truncation,
clippy::cast_sign_loss,
reason = "ilog(64)+1 fits usize; x%64 fits u8, indexes the 64-entry alphabet"
)]
pub fn encode_int<T>(value: T, min_len: NonZeroUsize) -> String
where
T: PrimInt + Unsigned + AsPrimitive<u64>,
{
let val: u64 = value.as_();
let required_len = if val == 0 { 1 } else { val.ilog(64) + 1 } as usize;
let final_length = required_len.max(min_len.get());
let mut out = String::with_capacity(final_length);
let mut pad = final_length;
while pad > required_len {
out.push('A');
pad -= 1;
}
let mut pos = required_len;
while pos > 0 {
pos -= 1;
let digit = (val >> (6 * pos)) % 64;
out.push(char::from(B64_ALPHABET[digit as usize]));
}
out
}
pub fn decode_int<T, N>(stream: T) -> Result<N, Error>
where
T: AsRef<[u8]>,
N: PrimInt + Unsigned + CheckedShl + 'static,
{
let mut out: N = N::zero();
for &b in stream.as_ref() {
let b64_val = b64_byte_to_index(b)?;
let wide_val = N::from(b64_val).ok_or(Error::IntegerOverflow)?;
if out.leading_zeros() < 6 {
return Err(Error::IntegerOverflow);
}
out = out
.checked_shl(6)
.and_then(|shifted| shifted.checked_add(&wide_val))
.ok_or(Error::IntegerOverflow)?;
}
Ok(out)
}
#[cfg(test)]
#[allow(
clippy::shadow_reuse,
clippy::shadow_same,
clippy::as_conversions,
clippy::cast_possible_truncation,
clippy::unreadable_literal,
reason = "test code: shadowing for ergonomics, as casts in proptest strategies, long literals from spec"
)]
mod test {
use super::{decode_int, encode_int};
use crate::b64::charset::is_b64_url_safe_charset;
use crate::b64::error::Error;
use core::num::NonZeroUsize;
use proptest::prelude::*;
use rstest::rstest;
proptest! {
#[test]
fn base64_value_len_is_valid( v in 0..101_u32, l in 1..1001_usize) {
let required_len = if v == 0 { 1 } else { (v.ilog(64) + 1) as usize };
let expected_len = required_len.max(l);
let required_length = NonZeroUsize::new(expected_len).unwrap();
let base64_output = encode_int( v,required_length);
prop_assert_eq!(base64_output.len(), expected_len, "the output is: {}, expected len: {}", base64_output, expected_len);
}
#[test]
fn base64_value_should_have_correct_char_as_prefix_when_len_is_large(v in 0..63_u32, l in 2..1001_usize) {
let required_length = NonZeroUsize::new(l).unwrap();
let base64_output = encode_int( v, required_length);
let first_char = base64_output.chars().next().unwrap();
prop_assert_eq!(first_char, 'A');
}
#[test]
fn base64_char_length_should_be_valid_if_len_is_0((v, sl) in (64..120213011_u32).prop_map(|v| {
let len = v.ilog(64) + 1;
(v, len)
})) {
let required_length = NonZeroUsize::new(1).unwrap();
let base64_output = encode_int(v, required_length);
prop_assert_eq!(base64_output.len(), sl as usize, "the output is:{}", base64_output);
}
}
#[rstest]
#[case(0, 1, "A")]
#[case(1, 1, "B")]
#[case(0, 2, "AA")]
#[case(1, 2, "AB")]
#[case(10, 4, "AAAK")]
#[case(27, 1, "b")]
#[case(27, 2, "Ab")]
#[case(80, 1, "BQ")]
#[case(248, 1, "D4")]
#[case(4095, 2, "__")]
#[case(4096, 1, "BAA")]
#[case(4096, 2, "BAA")]
#[case(6011, 1, "Bd7")]
#[case(16777215, 4, "____")]
#[case(0, 4, "AAAA")]
#[case(2, 1, "C")]
#[case(2, 2, "AC")]
#[case(65, 2, "BB")]
#[case(65, 4, "AABB")]
#[case(86, 4, "AABW")]
#[case(262143, 3, "___")]
fn u32_to_base64_should_be_valid(#[case] n: u32, #[case] length: usize, #[case] b64: &str) {
let length = NonZeroUsize::new(length).unwrap();
assert_eq!(encode_int(n, length), b64);
}
#[rstest]
#[case(0, 1, "A")]
#[case(1, 1, "B")]
#[case(0, 2, "AA")]
#[case(1, 2, "AB")]
#[case(10, 4, "AAAK")]
#[case(27, 1, "b")]
#[case(27, 2, "Ab")]
#[case(80, 1, "BQ")]
fn u8_to_base64_should_be_valid(#[case] n: u8, #[case] length: usize, #[case] b64: &str) {
let length = NonZeroUsize::new(length).unwrap();
assert_eq!(encode_int(n, length), b64);
}
#[rstest]
#[case(0, 1, "A")]
#[case(1, 1, "B")]
#[case(0, 2, "AA")]
#[case(1, 2, "AB")]
#[case(10, 4, "AAAK")]
#[case(27, 1, "b")]
#[case(27, 2, "Ab")]
#[case(80, 1, "BQ")]
fn u16_to_base64_should_be_valid(#[case] n: u16, #[case] length: usize, #[case] b64: &str) {
let length = NonZeroUsize::new(length).unwrap();
assert_eq!(encode_int(n, length), b64);
}
#[rstest]
#[case(4095, 2, "__")]
#[case(4096, 1, "BAA")]
#[case(6011, 1, "Bd7")]
#[case(16777215, 4, "____")]
#[case(4_294_967_295, 1, "D_____")] #[case(1_152_921_504_606_846_975, 1, "__________")] #[case(1_152_921_504_606_846_976, 1, "BAAAAAAAAAA")] #[case(u64::MAX - 1, 1, "P_________-")] #[case(u64::MAX, 1, "P__________")] fn u64_to_base64_should_be_valid(#[case] n: u64, #[case] length: usize, #[case] b64: &str) {
let length = NonZeroUsize::new(length).unwrap();
assert_eq!(encode_int(n, length), b64);
}
proptest! {
#[test]
fn encode_decode_u32_roundtrip(v in 0u32..16_777_216) {
use super::decode_int;
let encoded = encode_int(v, NonZeroUsize::new(1).unwrap());
let decoded: u32 = decode_int(&encoded).unwrap();
prop_assert_eq!(v, decoded);
}
#[test]
fn encode_decode_u64_roundtrip(v in 0u64..=u64::MAX) {
use super::decode_int;
let encoded = encode_int(v, NonZeroUsize::new(1).unwrap());
let decoded: u64 = decode_int(&encoded).unwrap();
prop_assert_eq!(v, decoded);
}
#[test]
fn encode_int_output_is_valid_b64(v in 0u32..16_777_216, l in 1usize..20) {
let len = NonZeroUsize::new(l).unwrap();
let encoded = encode_int(v, len);
prop_assert!(
is_b64_url_safe_charset(encoded.as_bytes()),
"output '{}' has non-B64 chars",
encoded
);
}
}
#[rstest]
#[case("A", 0)]
#[case("B", 1)]
#[case("b", 27)]
#[case("Ab", 27)]
#[case("BQ", 80)]
#[case("__", 4095)]
#[case("BAA", 4096)]
#[case("Bd7", 6011)]
#[case("____", 16_777_215)]
#[case("C", 2)]
#[case("AC", 2)]
#[case("BB", 65)]
#[case("AABB", 65)]
#[case("AABW", 86)]
fn base64_to_u32(#[case] b64: &str, #[case] output: u32) {
let actual: u32 = decode_int(b64).unwrap();
assert_eq!(actual, output);
}
#[rstest]
#[case("A", 0)]
#[case("B", 1)]
#[case("b", 27)]
#[case("Ab", 27)]
#[case("BQ", 80)]
fn base64_to_u8(#[case] b64: &str, #[case] output: u8) {
let actual: u8 = decode_int(b64).unwrap();
assert_eq!(actual, output);
}
#[rstest]
#[case("A", 0)]
#[case("B", 1)]
#[case("b", 27)]
#[case("Ab", 27)]
#[case("BQ", 80)]
fn base64_to_u16(#[case] b64: &str, #[case] output: u16) {
let actual: u16 = decode_int(b64).unwrap();
assert_eq!(actual, output);
}
#[rstest]
#[case("__", 4095)]
#[case("BAA", 4096)]
#[case("Bd7", 6011)]
#[case("____", 16_777_215)]
fn base64_to_u64(#[case] b64: &str, #[case] output: u64) {
let actual: u64 = decode_int(b64).unwrap();
assert_eq!(actual, output);
}
#[rstest]
#[case("__", 4095)]
#[case("BAA", 4096)]
#[case("Bd7", 6011)]
#[case("____", 16_777_215)]
fn base64_to_usize(#[case] b64: &str, #[case] output: usize) {
let actual: usize = decode_int(b64).unwrap();
assert_eq!(actual, output);
}
#[rstest]
#[case("__")]
#[case("BAA")]
#[case("E_")]
fn base64_to_u8_should_overflow(#[case] b64: &str) {
let actual = decode_int::<_, u8>(b64);
assert!(actual.is_err(), "Expected an overflow error, but got Ok");
let err = actual.unwrap_err();
assert!(
matches!(err, Error::IntegerOverflow),
"Expected Error::IntegerOverflow, but got {err:?}"
);
}
#[test]
fn decode_empty_string_is_zero() {
let result: u32 = decode_int("").unwrap();
assert_eq!(result, 0);
}
#[test]
fn decode_single_a_is_zero() {
let result: u32 = decode_int("A").unwrap();
assert_eq!(result, 0);
}
#[test]
fn decode_rejects_invalid_char_plus() {
let result = decode_int::<_, u32>("+");
let err = result.unwrap_err();
assert_eq!(err, Error::InvalidBase64Char('+'));
}
#[test]
fn decode_rejects_space() {
let result = decode_int::<_, u32>(" ");
let err = result.unwrap_err();
assert_eq!(err, Error::InvalidBase64Char(' '));
}
#[test]
fn decode_u16_overflow() {
let result = decode_int::<_, u16>("BAAA");
let err = result.unwrap_err();
assert_eq!(err, Error::IntegerOverflow);
}
#[test]
fn decode_max_u8() {
let result: u8 = decode_int("D_").unwrap();
assert_eq!(result, 255);
}
#[test]
fn decode_just_over_u8_max() {
let result = decode_int::<_, u8>("EA");
let err = result.unwrap_err();
assert_eq!(err, Error::IntegerOverflow);
}
#[test]
fn decode_max_u16() {
let result: u16 = decode_int("P__").unwrap();
assert_eq!(result, 65535);
}
#[test]
fn decode_rejects_slash() {
let result = decode_int::<_, u32>("/");
let err = result.unwrap_err();
assert_eq!(err, Error::InvalidBase64Char('/'));
}
#[test]
fn decode_rejects_equals() {
let result = decode_int::<_, u32>("=");
let err = result.unwrap_err();
assert_eq!(err, Error::InvalidBase64Char('='));
}
#[test]
fn decode_rejects_invalid_in_middle() {
let result = decode_int::<_, u32>("A+B");
let err = result.unwrap_err();
assert_eq!(err, Error::InvalidBase64Char('+'));
}
}