Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.Text.AhoCorasick.Searcher

Synopsis

data Searcher v
automaton :: Searcher v -> AcMachine v
build :: CaseSensitivity -> [Text] -> Searcher ()
buildNeedleIdSearcher :: CaseSensitivity -> [Text] -> Searcher Int
buildWithValues :: Hashable v => CaseSensitivity -> [(Text, v)] -> Searcher v
caseSensitivity :: Searcher v -> CaseSensitivity
containsAll :: Searcher Int -> Text -> Bool
containsAny :: Searcher () -> Text -> Bool
mapSearcher :: Hashable b => (a -> b) -> Searcher a -> Searcher b
needles :: Searcher v -> [(Text, v)]
numNeedles :: Searcher v -> Int
setCaseSensitivity :: CaseSensitivity -> Searcher v -> Searcher v

Documentation

data Searcher v Source #

A set of needles with associated values, and an Aho-Corasick automaton to efficiently find those needles.

INVARIANT: searcherAutomaton = Aho.build . searcherNeedles To enforce this invariant, the fields are not exposed from this module. There is a separate constructor function.

The purpose of this wrapper is to have a type that is Hashable and Eq, so we can derive those for types that embed the searcher, whithout requiring the automaton itself to be Hashable or Eq, which would be both wasteful and tedious. Because the automaton is fully determined by the needles and associated values, it is sufficient to implement Eq and Hashable in terms of the needles only.

We also use Hashed to cache the hash of the needles.

Instances

Instances details

(Hashable v, FromJSON v) => FromJSON (Searcher v) Source #
Instance details Defined in Data.Text.AhoCorasick.Searcher Methods parseJSON :: Value -> Parser (Searcher v) # parseJSONList :: Value -> Parser [Searcher v] #
ToJSON v => ToJSON (Searcher v) Source #
Instance details Defined in Data.Text.AhoCorasick.Searcher Methods toJSON :: Searcher v -> Value # toEncoding :: Searcher v -> Encoding # toJSONList :: [Searcher v] -> Value # toEncodingList :: [Searcher v] -> Encoding #
Semigroup (Searcher ()) Source #
Instance details Defined in Data.Text.AhoCorasick.Searcher Methods (<>) :: Searcher () -> Searcher () -> Searcher () # sconcat :: NonEmpty (Searcher ()) -> Searcher () # stimes :: Integral b => b -> Searcher () -> Searcher () #
Generic (Searcher v) Source #
Instance details Defined in Data.Text.AhoCorasick.Searcher Associated Types type Rep (Searcher v) :: Type -> Type # Methods from :: Searcher v -> Rep (Searcher v) x # to :: Rep (Searcher v) x -> Searcher v #
Show (Searcher v) Source #
Instance details Defined in Data.Text.AhoCorasick.Searcher Methods showsPrec :: Int -> Searcher v -> ShowS # show :: Searcher v -> String # showList :: [Searcher v] -> ShowS #
NFData v => NFData (Searcher v) Source #
Instance details Defined in Data.Text.AhoCorasick.Searcher Methods rnf :: Searcher v -> () #
Eq v => Eq (Searcher v) Source #
Instance details Defined in Data.Text.AhoCorasick.Searcher Methods (==) :: Searcher v -> Searcher v -> Bool # (/=) :: Searcher v -> Searcher v -> Bool #
Hashable v => Hashable (Searcher v) Source #
Instance details Defined in Data.Text.AhoCorasick.Searcher Methods hashWithSalt :: Int -> Searcher v -> Int # hash :: Searcher v -> Int #
type Rep (Searcher v) Source #
Instance details Defined in Data.Text.AhoCorasick.Searcher type Rep (Searcher v) = D1 ('MetaData "Searcher" "Data.Text.AhoCorasick.Searcher" "alfred-margaret-2.1.0.0-GaLGdvCW2mGJuL9TH52qO1" 'False) (C1 ('MetaCons "Searcher" 'PrefixI 'True) ((S1 ('MetaSel ('Just "searcherCaseSensitive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CaseSensitivity) :: S1 ('MetaSel ('Just "searcherNeedles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Hashed [(Text, v)]))) :: (S1 ('MetaSel ('Just "searcherNumNeedles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "searcherAutomaton") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (AcMachine v)))))

automaton :: Searcher v -> AcMachine v Source #

build :: CaseSensitivity -> [Text] -> Searcher () Source #

Builds the Searcher for a list of needles The caller is responsible that the needles are lower case in case the IgnoreCase is used for case sensitivity

buildNeedleIdSearcher :: CaseSensitivity -> [Text] -> Searcher Int Source #

Build a Searcher that returns the needle's index in the needle list when it matches.

buildWithValues :: Hashable v => CaseSensitivity -> [(Text, v)] -> Searcher v Source #

The caller is responsible that the needles are lower case in case the IgnoreCase is used for case sensitivity

caseSensitivity :: Searcher v -> CaseSensitivity Source #

containsAll :: Searcher Int -> Text -> Bool Source #

Returns whether the haystack contains all of the needles. This function expects the passed Searcher to be constructed using buildNeedleIdAutomaton.

containsAny :: Searcher () -> Text -> Bool Source #

Return whether the haystack contains any of the needles. Case sensitivity depends on the properties of the searcher This function is marked noinline as an inlining boundary. Aho.runText is marked inline, so this function will be optimized to report only whether there is a match, and not construct a list of matches. We don't want this function be inline, to make sure that the conditions of the caller don't affect how this function is optimized. There is little to gain from additional inlining. The pragma is not an optimization in itself, rather it is a defence against fragile optimizer decisions.

mapSearcher :: Hashable b => (a -> b) -> Searcher a -> Searcher b Source #

Modify the values associated with the needles.

needles :: Searcher v -> [(Text, v)] Source #

numNeedles :: Searcher v -> Int Source #

setCaseSensitivity :: CaseSensitivity -> Searcher v -> Searcher v Source #

Updates the case sensitivity of the searcher. Does not change the capitilization of the needles. The caller should be certain that if IgnoreCase is passed, the needles are already lower case.