# Rut

Rut is a small UTF-8 decoding library for applications that need to decode individual characters.\
It provides a bytewise decoder, and functions for decoding byte slices.

It is completely `no_std` and should provide good performance.<sup>[*citation needed*]</sup>

# Conformance

Rut is fully conformant to the specifications and restrictions of the [Unicode standard][unicode].\
Additionally, it follows [W3C's standard for UTF-8 decoding][w3c] with regards to error signalling.

# Testing

Tests are largely not implemented yet (aside from documentation examples).\
However, Rut has been extensively fuzzed and passes this [stress test for UTF-8 decoders][stress].

# As Seen on TV!

Rut began life, and is still used in, [Termiku], a terminal emulator written in Rust.

[unicode]: https://www.unicode.org/versions/latest/
[w3c]: https://www.w3.org/TR/encoding/#utf-8-decoder
[stress]: https://www.cl.cam.ac.uk/~mgk25/ucs/examples/UTF-8-test.txt
[Termiku]: https://github.com/ShinySaana/Termiku