Splits a string based on a regular expression. The regular expression should identify one delimiter.
This does not advance and produces an infinite list of  if the regex matches an empty string. This misfeature is here to match the behavior of the the original Text.Regex API.
Replaces every occurance of the given regexp with the replacement string.
In the replacement string,
"\1" refers to the first substring;
"\2" to the second, etc; and
"\0" to the entire match.
"\\\\" will insert a literal backslash.
This does not advance if the regex matches an empty string. This misfeature is here to match the behavior of the the original Text.Regex API.
Classes and instances for Regex matching.
To see what result types the instances of RegexContext can produce, please read the Text.Regex.Base.Context haddock documentation.
This does not provide any of the backends, just the common interface they all use. The modules which provide the backends and their cabal packages are:
Text.Regexfrom regex-compat (uses regex-posix)
In fact, just importing one of the backends is adequate, you do not also need to import this module.
TODO: Copy Example*hs files into this haddock comment
Module that provides the Regex backend that wraps the c posix regex api. This is the backend being used by the regex-compat package to replace Text.Regex
The Text.Regex.Posix module provides a backend for regular expressions. If you import this along with other backends, then you should do so with qualified imports, perhaps renamed for convenience.
=~~ functions are too high level, you can use the
compile, regexec, and execute functions from importing either
Text.Regex.Posix.String or Text.Regex.Posix.ByteString. If you
want to use a low-level
CString interface to the library,
then import Text.Regex.Posix.Wrap and use the wrap* functions.
Note that the posix library works with single byte characters, and does not understand Unicode. If you need Unicode support you will have to use a different backend.
When offsets are reported for subexpression captures, a subexpression
that did not match anything (as opposed to matching an empty string)
will have its offset set to the
unusedRegOffset value, which is (-1).
Benchmarking shows the default regex library on many platforms is very inefficient. You might increase performace by an order of magnitude by obtaining libpcre and regex-pcre or libtre and regex-tre. If you do not need the captured substrings then you can also get great performance from regex-dfa. If you do need the capture substrings then you may be able to use regex-parsec to improve performance.