Text.Regex.TDFA.ByteString.Lazy

regex-tdfa-1.1.1: Replaces/Enhances Text.Regex

Description

This modules provides RegexMaker and RegexLike instances for using ByteString with the DFA backend (Text.Regex.Lib.WrapDFAEngine and Text.Regex.Lazy.DFAEngineFPS). This module is usually used via import Text.Regex.TDFA.

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

Synopsis

data Regex

data CompOption

data ExecOption

compile :: CompOption -> ExecOption -> ByteString -> Either String Regex

execute :: Regex -> ByteString -> Either String (Maybe MatchArray)

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

Documentation

data Regex

The TDFA backend specific Regex type, used by this module's RegexOptions and RegexMaker

Instances

RegexLike Regex String

RegexLike Regex ByteString

RegexContext Regex String String

RegexContext Regex ByteString ByteString

RegexOptions Regex CompOption ExecOption

RegexMaker Regex CompOption ExecOption String

RegexMaker Regex CompOption ExecOption ByteString

RegexMaker Regex CompOption ExecOption (Seq Char)

RegexLike Regex (Seq Char)

RegexContext Regex (Seq Char) (Seq Char)

data CompOption

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.

Instances

Read CompOption

Show CompOption

RegexOptions Regex CompOption ExecOption

RegexMaker Regex CompOption ExecOption String

RegexMaker Regex CompOption ExecOption ByteString

RegexMaker Regex CompOption ExecOption (Seq Char)

data ExecOption

Instances

Read ExecOption

Show ExecOption

RegexOptions Regex CompOption ExecOption

RegexMaker Regex CompOption ExecOption String

RegexMaker Regex CompOption ExecOption ByteString

RegexMaker Regex CompOption ExecOption (Seq Char)

compile

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

execute

:: Regex	Compiled regular expression
-> ByteString	ByteString to match against
-> Either String (Maybe MatchArray)

regexec

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

Produced by Haddock version 2.3.0