regex-tdfa-1.1.4: Replaces/Enhances Text.RegexSource codeContentsIndex
Text.Regex.TDFA.String
Contents
Types
Medium level API functions
Description

This modules provides RegexMaker and RegexLike instances for using String with the TDFA backend.

This exports instances of the high level API and the medium level API of compile,execute, and regexec.

Synopsis
data Regex
type MatchOffset = Int
type MatchLength = Int
data CompOption
data ExecOption
compile :: CompOption -> ExecOption -> String -> Either String Regex
execute :: Regex -> String -> Either String (Maybe MatchArray)
regexec :: Regex -> String -> Either String (Maybe (String, String, String, [String]))
Types
data Regex Source
The TDFA backend specific Regex type, used by this module's RegexOptions and RegexMaker
type MatchOffset = IntSource
0 based index from start of source, or (-1) for unused
type MatchLength = IntSource
non-negative length of a match
data CompOption Source
Control whether the pattern is multiline or case-sensitive like Text.Regex and whether to capture the subgroups (1, 2, etc). Controls enabling extra anchor syntax.
data ExecOption Source
Medium level API functions
compileSource
:: CompOptionFlags (summed together)
-> ExecOptionFlags (summed together)
-> StringThe regular expression to compile (ASCII only, no null bytes)
-> Either String RegexReturns: the compiled regular expression
executeSource
:: RegexCompiled regular expression
-> StringString to match against
-> Either String (Maybe MatchArray)
regexecSource
:: RegexCompiled regular expression
-> StringString to match against
-> Either String (Maybe (String, String, String, [String]))
Produced by Haddock version 2.6.0