![ga-svg] ![crates-svg] ![docs-svg] ![codecov-svg] ![deps-svg]
Emoji256 is a binary-to-text encoding scheme for reading hashes and cryptographic keys. By translating text to pictographs, we can use our automatic biological storytelling machinery to grok or even memorize arbritrary byte sequences.
To translate 8-bit values to a table of 256 emojis, emoji256 utilizes a pre-defined lookup table found in src/table.rs. This table contains a unique emoji for each of the 256 possible combinations of an 8-bit value, ranging from 0 to 255. The lookup table is still actively being tweaked to reduce biases and increase grok-ability.
This Rust crate encodes and decodes data into/from emoji256. It uses the same API as the popular Rust crate, hex.
Encoding a String
```rust let encoded_string = emoji256::encode("Hello world!");
println!("{}", encoded_string); // Prints "🐙👽💉💉💌🍭💦💌💕💉👻🍰" ```
Decoding a String
```rust let decodedstring = String::fromutf8(emoji256::decode("🐙👽💉💉💌🍭💦💌💕💉👻🍰").unwrap()).unwrap();
println!("{}", decoded_string); // Prints "Hello world!" ```
You can find the documentation here.
In order to use this crate, you have to add it under [dependencies] to your Cargo.toml
toml
[dependencies]
emoji256 = "0.2"
By default this will import std, if you are working in a
no_std
environment you can turn this off by adding the following
toml
[dependencies]
emoji256 = { version = "0.2", default-features = false }
std:
Enabled by default. Add support for Rust's libstd types.alloc:
Enabled by default. Add support for alloc types (e.g. String) in no_std environment.serde:
Disabled by default. Add support for serde de/serializing library.
See the serde module documentation for usage.Licensed under either of
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.