Struct tantivy_analysis_contrib::phonetic::PhoneticTokenFilter

pub struct PhoneticTokenFilter { /* private fields */ }

Available on crate feature phonetic only.

This the phonetic token filter. It generates a token according to the algorithm provided.

You should use PhoneticAlgorithm to construct a new PhoneticTokenFilter.

use tantivy_analysis_contrib::phonetic::{Alternate, MaxCodeLength, PhoneticAlgorithm, PhoneticTokenFilter, Strict};

// Example with Double Metaphone.
let algorithm = PhoneticAlgorithm::DoubleMetaphone(MaxCodeLength(None), Alternate(false));
let token_filter = PhoneticTokenFilter::try_from(algorithm)?;

// Another example with Nysiis
let algorithm = PhoneticAlgorithm::Nysiis(Strict(None));
let token_filter = PhoneticTokenFilter::try_from(algorithm)?;

Trait Implementations

impl Clone for PhoneticTokenFilter

fn clone(&self) -> PhoneticTokenFilter

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PhoneticTokenFilter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl TokenFilter for PhoneticTokenFilter

type Tokenizer<T: Tokenizer> = PhoneticFilterWrapper<T>

The Tokenizer type returned by this filter, typically parametrized by the underlying Tokenizer.

fn transform<T: Tokenizer>(self, token_stream: T) -> Self::Tokenizer<T>

Wraps a Tokenizer and returns a new one.

impl TryFrom<&PhoneticAlgorithm> for PhoneticTokenFilter

Get the token filter from a PhoneticAlgorithm. This will take care of all the boilerplate.

Encoded values will be added as synonyms; that means the original token will be present.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &PhoneticAlgorithm) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<(&PhoneticAlgorithm, bool)> for PhoneticTokenFilter

Get the token filter from a PhoneticAlgorithm. This will take care of all the boilerplate.

The boolean indicates if encoded values should be treated as synonyms (true), in this case the original token will be present, or if it should replace (false) the original token.

type Error = Error

The type returned in the event of a conversion error.

fn try_from( (value, inject): (&PhoneticAlgorithm, bool) ) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<(PhoneticAlgorithm, bool)> for PhoneticTokenFilter

Get the token filter from a PhoneticAlgorithm. This will take care of all the boilerplate.

The boolean indicates if encoded values should be treated as synonyms (true), in this case the original token will be present, or if it should replace (false) the original token.

type Error = Error

The type returned in the event of a conversion error.

fn try_from( (value, inject): (PhoneticAlgorithm, bool) ) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<PhoneticAlgorithm> for PhoneticTokenFilter

Get the token filter from a PhoneticAlgorithm. This will take care of all the boilerplate.

Encoded values will be added as synonyms; that means the original token will be present.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: PhoneticAlgorithm) -> Result<Self, Self::Error>

Performs the conversion.