bs64 0.1.0

SIMD-accelerated Base64 encoding and decoding library
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

# 🚀 Base 64 

✨ SIMD-accelerated Base64 for Rust ✨

## 🌟 Features
- 💡 Uses AVX2 instructions for super-fast encoding and decoding
- 🔄 Fallback when AVX2 is unavailable uses any available SIMD

## 🎯 Project goals
- 🔧 Simple, idiomatic API
- 📦 Sensible defaults
- ⚡ Fast

## Usage

```rust
use bs64;

fn main() {
  // Encode
  let input = vec![2, 3, 4, 5];
  let output: String = bs64::encode(&input);

  // Decode
  let decoded_output = bs64::decode(output.as_bytes());
}
```

## Benchmarks

Ran using 100k inputs, 10000 iterations on an Intel® Core™ i7-1065G7:
```
cargo run --features "cli" --release -- -b 100000 -i 10000
```

### Encode

| name                  | MB/s
|----------------------|--------
|🚀 **bs64::encode()**    | 4813.70        
|🚀 **bs64::encode_mut()**| 6579.17        
|🚀 **bs64 fallback**         | 944.18         
|data_encoding         | 858.51         
|data_encoding mut     | 873.28         
|base64                | 748.02         
|base64 mut            | 870.99 

## Decode

| name                   | MB/s          |
|------------------------|---------------|
| 🚀 **bs64::decode()**     | 3899.26       |
| 🚀 **bs64::decode_mut()** | 3965.25       |
| 🚀 **bs64 fallback**          | 837.17        |
| data_encoding          | 647.33        |
| data_encoding mut      | 684.01        |
| base64                 | 761.68        |
| base64 mut             | 805.60        |


## TODO

- [x] Integration tests
- [x] Benchmarking suite
- [ ] Regression tests + benchmark in Github Actions
- [ ] Change default implementation with feature flags
- [ ] Builders for custom configs at runtime