mcountryman / cesu8-rs

Rust library which converts between UTF-8 and CESU-8 encodings.

CESU-8 encoder/decoder for Rust

Documentation.

Convert between ordinary UTF-8 and CESU-8 encodings.

CESU-8 encodes characters outside the Basic Multilingual Plane as two UTF-16 surrogate chacaters, which are then further re-encoded as invalid, 3-byte UTF-8 characters. This means that 4-byte UTF-8 sequences become 6-byte CESU-8 sequences.

Note that CESU-8 is only intended for internal use within tightly-coupled systems, and not for data interchange.

This encoding is sometimes needed when working with Java, Oracle or MySQL, and when trying to store emoji, hieroglyphs, or other characters on the Supplementary Multilingual Plane or the Supplementary Ideographic Plane.

We also support Java's Modified UTF-8 encoding, which encodes \0 using a multi-byte UTF-8 sequence.

Features

Below are the available cargo feature flags.

• std - use the standard library (enabled by default).
• unstable - Allow access to unstable features when being built with a nightly compiler, to keep travis-cargo happy and enable access to benchmarks if we want them.

License

Some of this code is adapted from Rust's src/libcore/str.rs file. This code is covered by LICENSE-RUST.txt and copyright by The Rust Project Developers and individual Rust contributors, as described in that file.

The new code in this project is distributed under the same terms.