covo 0.1.0

Consonant-vowel binary encoding for human-pronounceable strings
Documentation
  • Coverage
  • 36.59%
    15 out of 41 items documented1 out of 19 items with examples
  • Size
  • Source code size: 43.57 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 3.7 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 20s Average build duration of successful builds.
  • all releases: 20s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Repository
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • nc7s

covo

Consonant-vowel binary encoding for human-pronounceable strings.

let encoded = covo::encode(b"\xCA\xFE");
assert_eq!(encoded, "bafaba-roputa");
assert_eq!(covo::decode(&encoded).unwrap(), b"\xCA\xFE");

Encoded strings include a checksum and are self-describing: [decode] only needs the alphabet, not the encoder's configuration. Non-alphabet characters are silently ignored, so separators and whitespace are transparent to the decoder.

Use [encode] / [decode] with defaults, or [encode_with] / [decode_with] for a custom [Alphabet] or [Config].

Custom alphabets accept English consonants and vowels only (for simplicity and pronounceability).