Crate cologne_phonetics

Crate cologne_phonetics 

Source
Expand description

Implementation of cologne codes or “Kölner Phonetik” see https://en.wikipedia.org/wiki/Cologne_phonetics for more information.

This crate is mainly used by either calling utf8_to_cologne_phonetics_vec or preferably creating a CologneVec and using its read_from_utf8 function.

§Example

let mut buf = CologneVec::new();
buf.read_from_utf8("Marius Macher".as_bytes());
assert_eq!(buf, CologneVec::from_codes(&[
    CologneCode::Class6,
    CologneCode::Class7,
    CologneCode::Class8,
    CologneCode::Space,
    CologneCode::Class6,
    CologneCode::Class4,
    CologneCode::Class7,
]))

Structs§

CologneVec
Optimized data structure to store CologneCodes.

Enums§

CologneCode
A representation of CologneCodes stored in a a nibble.

Functions§

cologne_code_vec_to_bytevec
Convert the Vec<CologneCode> to a Vec<u8> without any iteration or allocation.
utf8_to_cologne_phonetics_string
Write characters of cologne codes
utf8_to_cologne_phonetics_vec
Read the given utf8 bytes into the outbuf. Generally you should prefer using a CologneVec