README.md
1[![CI Status][ci_badge]][ci]
2[![Coverage Status][coveralls_badge]][coveralls]
3
4This library provides the following common encodings:
5
6| Name | Description |
7|--------------------------|--------------------------------------------------------|
8| `HEXLOWER` | lowercase hexadecimal |
9| `HEXLOWER_PERMISSIVE` | lowercase hexadecimal (case-insensitive decoding) |
10| `HEXUPPER` | uppercase hexadecimal |
11| `HEXUPPER_PERMISSIVE` | uppercase hexadecimal (case-insensitive decoding) |
12| `BASE32` | RFC4648 base32 |
13| `BASE32_NOPAD` | RFC4648 base32 (no padding) |
14| `BASE32_NOPAD_NOCASE` | RFC4648 base32 (no padding, case-insensitive decoding) |
15| `BASE32_NOPAD_VISUAL` | RFC4648 base32 (no padding, visual-approx. decoding) |
16| `BASE32HEX` | RFC4648 base32hex |
17| `BASE32HEX_NOPAD` | RFC4648 base32hex (no padding) |
18| `BASE32_DNSSEC` | RFC5155 base32 |
19| `BASE32_DNSCURVE` | DNSCurve base32 |
20| `BASE64` | RFC4648 base64 |
21| `BASE64_NOPAD` | RFC4648 base64 (no padding) |
22| `BASE64_MIME` | RFC2045-like base64 |
23| `BASE64_MIME_PERMISSIVE` | RFC2045-like base64 (ignoring trailing bits) |
24| `BASE64URL` | RFC4648 base64url |
25| `BASE64URL_NOPAD` | RFC4648 base64url (no padding) |
26
27It also provides the possibility to define custom little-endian ASCII
28base-conversion encodings for bases of size 2, 4, 8, 16, 32, and 64 (for which
29all above use-cases are particular instances).
30
31See the [documentation] for more details.
32
33[ci]: https://github.com/ia0/data-encoding/actions/workflows/ci.yml
34[ci_badge]: https://github.com/ia0/data-encoding/actions/workflows/ci.yml/badge.svg
35[coveralls]: https://coveralls.io/github/ia0/data-encoding?branch=main
36[coveralls_badge]: https://coveralls.io/repos/github/ia0/data-encoding/badge.svg?branch=main
37[documentation]: https://docs.rs/data-encoding
38
