Text.Regex.DFA.Sequence

regex-dfa-0.91: Replaces/Enhances Text.Regex

Contents

Types
Medium level API functions

Description

This modules provides RegexMaker and RegexLike instances for using 'Seq Char' with the DFA backend (Text.Regex.Lib.WrapDFAEngine and Text.Regex.Lazy.DFAEngine). This module is usually used via import Text.Regex.DFA.

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

Synopsis

data Regex

MatchOffset

MatchLength

data CompOption

data ExecOption

compile :: CompOption -> ExecOption -> Seq Char -> Either String Regex

execute :: Regex -> Seq Char -> Either String (Maybe (Array Int (MatchOffset, MatchLength)))

regexec :: Regex -> Seq Char -> Either String (Maybe (Seq Char, Seq Char, Seq Char, [Seq Char]))

Types

data Regex

The DFA backend specific Regex type, used by this module's =~ and =~~ operators.

Instances

RegexLike Regex ByteString

RegexLike Regex String

RegexContext Regex ByteString ByteString

RegexContext Regex String String

RegexOptions Regex CompOption ExecOption

RegexMaker Regex CompOption ExecOption ByteString

RegexMaker Regex CompOption ExecOption String

RegexMaker Regex CompOption ExecOption (Seq Char)

RegexLike Regex (Seq Char)

RegexContext Regex (Seq Char) (Seq Char)

MatchOffset

MatchLength

data CompOption

RegexOption control whether the pattern is multiline or case-sensitive like Text.Regex and whether to capture the subgroups (1, 2, etc).

Instances

RegexOptions Regex CompOption ExecOption

RegexMaker Regex CompOption ExecOption ByteString

RegexMaker Regex CompOption ExecOption String

RegexMaker Regex CompOption ExecOption (Seq Char)

data ExecOption

Instances

RegexOptions Regex CompOption ExecOption

RegexMaker Regex CompOption ExecOption ByteString

RegexMaker Regex CompOption ExecOption String

RegexMaker Regex CompOption ExecOption (Seq Char)

Medium level API functions

compile

:: CompOption	Flags (summed together)
-> ExecOption	Flags (summed together)
-> Seq Char	The regular expression to compile
-> Either String Regex	Returns: the compiled regular expression

execute

:: Regex	Compiled regular expression
-> Seq Char	Seq Char to match against
-> Either String (Maybe (Array Int (MatchOffset, MatchLength)))

regexec

:: Regex	Compiled regular expression
-> Seq Char	Seq Char to match against
-> Either String (Maybe (Seq Char, Seq Char, Seq Char, [Seq Char]))

Produced by Haddock version 0.8