Safe Haskell	None
Language	Haskell2010

Data.Text.AhoCorasick.Replacer

Contents

State machine

Description

Implements sequential string replacements based on the Aho-Corasick algorithm.

Synopsis

type Needle = Text
data Payload = Payload {
- needlePriority :: !Priority
- needleLength :: !CodeUnitIndex
- needleReplacement :: !Replacement
}
type Replacement = Text
data Replacer = Replacer {
- replacerCaseSensitivity :: CaseSensitivity
- replacerSearcher :: Searcher Payload
}
build :: CaseSensitivity -> [(Needle, Replacement)] -> Replacer
compose :: Replacer -> Replacer -> Maybe Replacer
run :: Replacer -> Text -> Text
runWithLimit :: Replacer -> CodeUnitIndex -> Text -> Maybe Text

State machine

type Needle = Text Source #

Descriptive type alias for strings to search for.

data Payload Source #

Constructors

Payload
Fields needlePriority :: !Priority needleLength :: !CodeUnitIndex needleReplacement :: !Replacement

Instances

Instances details

Eq Payload Source #
Instance details Defined in Data.Text.AhoCorasick.Replacer Methods (==) :: Payload -> Payload -> Bool # (/=) :: Payload -> Payload -> Bool #
Show Payload Source #
Instance details Defined in Data.Text.AhoCorasick.Replacer Methods showsPrec :: Int -> Payload -> ShowS # show :: Payload -> String # showList :: [Payload] -> ShowS #
Generic Payload Source #
Instance details Defined in Data.Text.AhoCorasick.Replacer Associated Types type Rep Payload :: Type -> Type # Methods from :: Payload -> Rep Payload x # to :: Rep Payload x -> Payload #
Hashable Payload Source #
Instance details Defined in Data.Text.AhoCorasick.Replacer Methods hashWithSalt :: Int -> Payload -> Int # hash :: Payload -> Int #
ToJSON Payload Source #
Instance details Defined in Data.Text.AhoCorasick.Replacer Methods toJSON :: Payload -> Value # toEncoding :: Payload -> Encoding # toJSONList :: [Payload] -> Value # toEncodingList :: [Payload] -> Encoding #
FromJSON Payload Source #
Instance details Defined in Data.Text.AhoCorasick.Replacer Methods parseJSON :: Value -> Parser Payload # parseJSONList :: Value -> Parser [Payload] #
NFData Payload Source #
Instance details Defined in Data.Text.AhoCorasick.Replacer Methods rnf :: Payload -> () #
type Rep Payload Source #
Instance details Defined in Data.Text.AhoCorasick.Replacer type Rep Payload

type Replacement = Text Source #

Descriptive type alias for replacements.

data Replacer Source #

A state machine used for efficient replacements with many different needles.

Constructors

Replacer
Fields replacerCaseSensitivity :: CaseSensitivity replacerSearcher :: Searcher Payload

Instances

Instances details

Eq Replacer Source #
Instance details Defined in Data.Text.AhoCorasick.Replacer Methods (==) :: Replacer -> Replacer -> Bool # (/=) :: Replacer -> Replacer -> Bool #
Show Replacer Source #
Instance details Defined in Data.Text.AhoCorasick.Replacer Methods showsPrec :: Int -> Replacer -> ShowS # show :: Replacer -> String # showList :: [Replacer] -> ShowS #
Generic Replacer Source #
Instance details Defined in Data.Text.AhoCorasick.Replacer Associated Types type Rep Replacer :: Type -> Type # Methods from :: Replacer -> Rep Replacer x # to :: Rep Replacer x -> Replacer #
Hashable Replacer Source #
Instance details Defined in Data.Text.AhoCorasick.Replacer Methods hashWithSalt :: Int -> Replacer -> Int # hash :: Replacer -> Int #
ToJSON Replacer Source #
Instance details Defined in Data.Text.AhoCorasick.Replacer Methods toJSON :: Replacer -> Value # toEncoding :: Replacer -> Encoding # toJSONList :: [Replacer] -> Value # toEncodingList :: [Replacer] -> Encoding #
FromJSON Replacer Source #
Instance details Defined in Data.Text.AhoCorasick.Replacer Methods parseJSON :: Value -> Parser Replacer # parseJSONList :: Value -> Parser [Replacer] #
NFData Replacer Source #
Instance details Defined in Data.Text.AhoCorasick.Replacer Methods rnf :: Replacer -> () #
type Rep Replacer Source #
Instance details Defined in Data.Text.AhoCorasick.Replacer type Rep Replacer = D1 ('MetaData "Replacer" "Data.Text.AhoCorasick.Replacer" "alfred-margaret-2.0.0.0-AHkhEWrSlE7G50v2ifxOcH" 'False) (C1 ('MetaCons "Replacer" 'PrefixI 'True) (S1 ('MetaSel ('Just "replacerCaseSensitivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CaseSensitivity) :*: S1 ('MetaSel ('Just "replacerSearcher") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Searcher Payload))))

build :: CaseSensitivity -> [(Needle, Replacement)] -> Replacer Source #

Build an Aho-Corasick automaton that can be used for performing fast sequential replaces.

Case-insensitive matching performs per-letter language-agnostic lower-casing. Therefore, it will work in most cases, but not in languages where lower-casing depends on the context of the character in question.

We need to revisit this algorithm when we want to implement full Unicode support.

compose :: Replacer -> Replacer -> Maybe Replacer Source #

Return the composition replacer2 after replacer1, if they have the same case sensitivity. If the case sensitivity differs, Nothing is returned.

run :: Replacer -> Text -> Text Source #

runWithLimit :: Replacer -> CodeUnitIndex -> Text -> Maybe Text Source #