Crate rphonetic

Expand description

This library contains a set of phonetic algorithms from Apache commons-codec written in Rust.

It currently implements :

Please note that most of these algorithms are design for ASCII, and they are usually design for certain use case (eg. english names, …etc).

§Feature flags

There is two features that provide default rules and Default implementation for some struct. They are not enabled by default as files are embedded into code, so it might increase binary size. It’s best to provide rules by your own.

embedded — Shorthand for embedded_bm and embedded_dm
embedded_bm — Beider-Morse rules. It includes only any language and other files that are required. All file can be found in commons-codec repository
embedded_dm — Daitch-Mokotoff rules. They can be also found in commons-codec repository

Structs§

BeiderMorse: This is the Beider-Morse encoder. It needs rules to work, you can get them from commons-codec. If feature embedded_bm, the default rules will be included in binary, it contains only any and common rules from commons-codec.
BeiderMorseBuilder: This is a builder to construct a BeiderMorse encoder. By default, it will use generic name type, approximate rules, it won’t concatenate multiple phonetic encoding.
Caverphone1: This a Caverphone 1 encoder.
Caverphone2: This a Caverphone 2 encoder.
CharSequence: This struct is a wrapper around an &str allowing to slice by char.
Cologne: This a Cologne encoder.
ConfigFiles: This structures contains languages set, rules and language guessing rules. It avoids parsing files multiple time and should be thread-safe.
DaitchMokotoffSoundex: This the Daitch Mokotoff soundex implementation.
DaitchMokotoffSoundexBuilder: This is a builder for DaitchMokotoffSoundex.
DoubleMetaphone: This is the Double Metaphone implementation.
DoubleMetaphoneResult: This struct represents a double metaphone result. It contains both primary and alternate code.
MatchRatingApproach: This the match rating approach Encoder.
Metaphone: This is the Metaphone implementation of Encoder.
Nysiis: This the Nysiis algorithm.
ParseError: This represents a parsing error. It contains the line number, the line, and if possible the filename.
Phonex: Phonex is a modification of the venerable Soundex algorithm. It accounts for a few more letter combinations to improve accuracy on some data sets. It was created by A.J. Lait and Brian Randell in 1996, described in their paper “An assessment of name matching algorithms” in the Technical Report Series published by the University of Newcastle Upon Tyne Computing Science.
RefinedSoundex: This the refined soundex implementation of Encoder.
Soundex: This is the Soundex implementation of Encoder.

Enums§

BMError: Beider-Morse errors.
LanguageSet: This represents a set of languages.
NameType: Supported type of names. Unless you are matching particular family name, use generic variant as it should work reasonably well for non-name words. The other variant are specifically tune for family name and may not work well for general text.
PhoneticError: Errors
RuleType: Type of rules.

Constants§

DEFAULT_US_ENGLISH_GENEALOGY_MAPPING_SOUNDEX: A mapping from Genealogy site.
DEFAULT_US_ENGLISH_MAPPING_SOUNDEX: This is the default mapping character for soundex.

Traits§