fashex 0.0.2

Conversion from bytes to hexadecimal string.
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

# fashex - fast hexadecimal string formatting

[![Crates.io][crates-badge]][crates-url]
[![Documentation][docs-badge]][docs-url]
[![License][license-badge]][license-url]

[crates-badge]: https://img.shields.io/crates/v/fashex
[crates-url]: https://crates.io/crates/fashex
[docs-badge]: https://docs.rs/fashex/badge.svg
[docs-url]: https://docs.rs/fashex
[license-badge]: https://img.shields.io/crates/l/fashex
[license-url]: https://codeberg.org/Hanyu/fashex/src/branch/main/LICENSE-APACHE

## Features

- Precise public APIs (`encode` or `decode`).
- Best-effort SIMD acceleration.
- APIs that works in const contexts.
- Unlike crates `const-hex`, `faster-hex`, etc., this crate does not require initialization of the output buffer.

## Roadmap to 1.0

Theoretically, the current version of this crate is already stable and ready for production use: the core APIs are unlikely to change, and all tests are passing. However, there're still some questions:

1. Does it worth a feature flag disabling SIMD acceleration? If so, should it be enabled by default?

   Currently, we don't have such feature flag and SIMD acceleration is enabled by default.

1. Does it worth a feature flag enabling runtime CPU features detection? If so, should it be enabled by default?

   Currently, we don't have such feature flag and runtime CPU features detection is enabled by default.

## Disclaimer

Although all tests are passing and hours of fuzz tests show no failures, there may still be bugs lurking in the code. If you find any bugs, please report them.

## Acknowledgements

This crate is highly inspired by the following repositories:

- [`const-hex`](https://github.com/DaniPopes/const-hex), SPDX-License-Identifier: MIT OR Apache-2.0
- [`faster-hex`](https://github.com/nervosnetwork/faster-hex), SPDX-License-Identifier: MIT OR Apache-2.0
- [`hex-simd`](https://github.com/Nugine/simd), SPDX-License-Identifier: MIT

#### License

<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
</sup>

<br>

<sub>
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in these crates by you, as defined in the Apache-2.0 license,
shall be dual licensed as above, without any additional terms or conditions.
</sub>