Text.RE.TDFA

Tutorial

We have a regex tutorial at http://tutorial.regex.uk. These API docs are mainly for reference.

The Overloaded Match Operators

(*=~) :: IsRegex RE s => s -> RE -> Matches s

find all matches in text

(?=~) :: IsRegex RE s => s -> RE -> Match s

find first match in text

(=~) :: (RegexContext Regex s a, RegexMaker Regex CompOption ExecOption s) => s -> RE -> a

the regex-base polymorphic match operator

(=~~) :: (Monad m, RegexContext Regex s a, RegexMaker Regex CompOption ExecOption s) => s -> RE -> m a

the regex-base monadic, polymorphic match operator

The Toolkit

Beyond the above match operators and the regular expression type below, Text.RE contains the toolkit for replacing captures, specifying options, etc.

module Text.RE

The RE Type

Text.RE.TDFA.RE contains the toolkit specific to the RE type, the type generated by the gegex compiler.

module Text.RE.TDFA.RE

The Operator Instances

These modules merely provide the instances for the above regex match operators at the various text types.

module Text.RE.TDFA.ByteString

module Text.RE.TDFA.ByteString.Lazy

module Text.RE.TDFA.Sequence

module Text.RE.TDFA.String

module Text.RE.TDFA.Text

module Text.RE.TDFA.Text.Lazy