fastbase91-core 0.1.3

Safe, no_std basE91 binary-to-text codec; the Rust core of fastbase91
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

<!-- This file is also the package page on PyPI (fastbase91) and crates.io (fastbase91-core). PyPI breaks relative links: keep every link absolute. -->
# fastbase91

[![crates.io](https://img.shields.io/crates/v/fastbase91-core.svg)](https://crates.io/crates/fastbase91-core)
[![PyPI](https://img.shields.io/pypi/v/fastbase91.svg)](https://pypi.org/project/fastbase91/)
[![Rust CI](https://github.com/birdhackor/fastbase91/actions/workflows/rust.yml/badge.svg)](https://github.com/birdhackor/fastbase91/actions/workflows/rust.yml)
[![Python CI](https://github.com/birdhackor/fastbase91/actions/workflows/python.yml/badge.svg)](https://github.com/birdhackor/fastbase91/actions/workflows/python.yml)
[![License: MIT OR Apache-2.0](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg)](https://github.com/birdhackor/fastbase91#license)

A fast [basE91](https://base91.sourceforge.net/) binary-to-text codec: a
`no_std`, `#![forbid(unsafe_code)]` Rust core (`fastbase91-core`) with a
PyO3-based Python binding (`fastbase91`).

basE91 packs binary data into 91 printable ASCII characters, giving roughly
23% size overhead — noticeably tighter than base64's ~33%.

## Features

- **Fast** — a tight Rust core; on GIL-enabled CPython, one-shot
  `encode()`/`decode()` calls with inputs of at least 1 KiB release the GIL so
  calls can overlap.
- **Safe** — `#![forbid(unsafe_code)]` throughout the core.
- **Portable** — `no_std` core (optional `alloc`/`std`); runs on bare metal.
- **Streaming** — incremental `Encoder`/`Decoder` for data that does not fit in
  memory at once.
- **Free-threaded ready** — the Python extension declares `gil_used = false`
  and ships free-threaded wheels (CPython 3.14t / 3.15t).
- **Stable-ABI wheels** — one abi3 wheel per platform covers GIL-enabled
  CPython 3.11+; free-threaded 3.14 has its own wheel, and CPython 3.15+
  (regular or free-threaded) can use a combined `abi3`/`abi3t` wheel.

## Install

Rust:

```sh
cargo add fastbase91-core
```

Python:

```sh
pip install fastbase91      # or: uv add fastbase91
```

## Usage

Rust:

```rust
use fastbase91_core::{encode, decode, DecodeOptions};

let encoded = encode(b"hello").unwrap();  // -> b"TPwJh>A"
let decoded = decode(&encoded, DecodeOptions::default()).unwrap();
assert_eq!(decoded, b"hello");
```

Python:

```python
import fastbase91

encoded = fastbase91.encode(b"hello")     # -> b"TPwJh>A"
assert fastbase91.decode(encoded) == b"hello"
```

## Documentation

Full documentation (English / 正體中文), including usage, installation and
platform compatibility, API reference, free-threading, benchmarks, and a
changelog:
**https://birdhackor.github.io/fastbase91/**

## Versioning

The Rust core and the Python package are released on two independent version
lines: `fastbase91-core` on [crates.io](https://crates.io/crates/fastbase91-core)
via `fastbase91-core-vX.Y.Z` tags, and `fastbase91` wheels on
[PyPI](https://pypi.org/project/fastbase91/) via `vX.Y.Z` tags. See
[MAINTENANCE.md](https://github.com/birdhackor/fastbase91/blob/main/MAINTENANCE.md)
for the release runbook.

## License

Licensed under either of
[MIT](https://github.com/birdhackor/fastbase91/blob/main/LICENSE-MIT) or
[Apache-2.0](https://github.com/birdhackor/fastbase91/blob/main/LICENSE-APACHE)
at your option.