Struct IbMatcher 

pub struct IbMatcher<'a, HaystackStr = str>
where
    HaystackStr: EncodedStr + ?Sized,
{ /* private fields */ }

Example

// cargo add ib-matcher --features pinyin,romaji
use ib_matcher::{
    matcher::{IbMatcher, PinyinMatchConfig, RomajiMatchConfig},
    pinyin::PinyinNotation,
};

let matcher = IbMatcher::builder("la vie est drôle").build();
assert!(matcher.is_match("LA VIE EST DRÔLE"));

let matcher = IbMatcher::builder("βίος").build();
assert!(matcher.is_match("Βίοσ"));
assert!(matcher.is_match("ΒΊΟΣ"));

let matcher = IbMatcher::builder("pysousuoeve")
    .pinyin(PinyinMatchConfig::notations(
        PinyinNotation::Ascii | PinyinNotation::AsciiFirstLetter,
    ))
    .build();
assert!(matcher.is_match("拼音搜索Everything"));

let matcher = IbMatcher::builder("konosuba")
    .romaji(RomajiMatchConfig::default())
    .is_pattern_partial(true)
    .build();
assert!(matcher.is_match("この素晴らしい世界に祝福を"));

Design

API follows regex::Regex.

Performance

• If you need to build IbMatcher multiple times, pass PinyinMatchConfigBuilder::data to the builder or use PinyinMatchConfig::shallow_clone() to avoid re-initializing the pinyin data every time. Same for RomajiMatchConfig.
• For matching more than 1000 strings, enable IbMatcherBuilder::analyze to optimize the pattern further. (The analysis costs ~65us, equivalent to about 220~1100 matches.)
• If you only need to call IbMatcher::test (or IbMatcher::test_and_try_for_each), set starts_with to improve performance.

TODO: No-pinyin pattern optimization TODO: Anchors, *_at TODO: Unicode normalization TODO: No-hanzi haystack optimization (0.2/0.9%) TODO: If pattern doesn’t contain ., only match before . in the haystack

Implementations

impl<'a, HaystackStr> IbMatcher<'a, HaystackStr>

where HaystackStr: EncodedStr + ?Sized,

pub fn with_config<'p>( pattern: impl Into<Pattern<'p, HaystackStr>>, config: MatchConfig<'a>, ) -> Self

where HaystackStr: 'p,

pub fn find<'h>( &'a self, input: impl Into<Input<'h, HaystackStr>>, ) -> Option<Match>

where HaystackStr: 'h,

This routine searches for the first match of this pattern in the haystack given, and if found, returns a Match. The Match provides access to both the byte offsets of the match and Match::is_pattern_partial().

Note that this should only be used if you want to find the entire match. If instead you just want to test the existence of a match, it’s potentially faster to use IbMatcher::is_match() instead of IbMatcher::find().is_some().

pub fn is_match<'h>(&self, input: impl Into<Input<'h, HaystackStr>>) -> bool

where HaystackStr: 'h,

Returns true if and only if there is a match for the pattern anywhere in the haystack given.

It is recommended to use this method if all you need to do is test whether a match exists, since the underlying matching engine may be able to do less work.

pub fn test<'h>( &self, input: impl Into<Input<'h, HaystackStr>>, ) -> Option<Match>

where HaystackStr: 'h,

This routine tests if this pattern matches the haystack at the start, and if found, returns a Match. The Match provides access to both the byte offsets of the match and Match::is_pattern_partial().

Returns

• Match.start() is guaranteed to be 0.
• If there are multiple possible matches, the longer ones are preferred. But the result is not guaranteed to be the longest one.

pub fn test_and_try_for_each<'h, T>( &self, input: impl Into<Input<'h, HaystackStr>>, f: &mut impl FnMut(Match) -> Option<T>, ) -> Option<T>

where HaystackStr: 'h,

This routine tests if this pattern matches the haystack at the start, and if found, calls f, and returns a [T] if it returns Some.

Arguments

• f: The Match provides access to both the byte offsets of the match and Match::is_pattern_partial().
  • Match.start() is guaranteed to be 0.

pub fn is_haystack_too_short(&self, haystack: &HaystackStr) -> bool

Already tested in match methods.

pub fn builder<'p>( pattern: impl Into<Pattern<'p, HaystackStr>>, ) -> IbMatcherBuilder<'a, 'p, HaystackStr>

Trait Implementations

impl Debug for IbMatcher<'_, str>

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

Formats the value using the given formatter.