regex-tdfa-1.3.2.2: Pure Haskell Tagged DFA Backend for "Text.Regex" (regex-base)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Text.Regex.TDFA.ByteString

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

Documentation

data Regex #

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

Instances

Instances details
RegexLike Regex ByteString # 
Instance details

Defined in Text.Regex.TDFA.ByteString

Methods

matchOnce :: Regex -> ByteString -> Maybe MatchArray #

matchAll :: Regex -> ByteString -> [MatchArray] #

matchCount :: Regex -> ByteString -> Int #

matchTest :: Regex -> ByteString -> Bool #

matchAllText :: Regex -> ByteString -> [MatchText ByteString] #

matchOnceText :: Regex -> ByteString -> Maybe (ByteString, MatchText ByteString, ByteString) #

RegexLike Regex ByteString # 
Instance details

Defined in Text.Regex.TDFA.ByteString.Lazy

Methods

matchOnce :: Regex -> ByteString -> Maybe MatchArray #

matchAll :: Regex -> ByteString -> [MatchArray] #

matchCount :: Regex -> ByteString -> Int #

matchTest :: Regex -> ByteString -> Bool #

matchAllText :: Regex -> ByteString -> [MatchText ByteString] #

matchOnceText :: Regex -> ByteString -> Maybe (ByteString, MatchText ByteString, ByteString) #

RegexLike Regex Text #

Since: 1.3.1

Instance details

Defined in Text.Regex.TDFA.Text

Methods

matchOnce :: Regex -> Text -> Maybe MatchArray #

matchAll :: Regex -> Text -> [MatchArray] #

matchCount :: Regex -> Text -> Int #

matchTest :: Regex -> Text -> Bool #

matchAllText :: Regex -> Text -> [MatchText Text] #

matchOnceText :: Regex -> Text -> Maybe (Text, MatchText Text, Text) #

RegexLike Regex Text #

Since: 1.3.1

Instance details

Defined in Text.Regex.TDFA.Text.Lazy

Methods

matchOnce :: Regex -> Text -> Maybe MatchArray #

matchAll :: Regex -> Text -> [MatchArray] #

matchCount :: Regex -> Text -> Int #

matchTest :: Regex -> Text -> Bool #

matchAllText :: Regex -> Text -> [MatchText Text] #

matchOnceText :: Regex -> Text -> Maybe (Text, MatchText Text, Text) #

RegexLike Regex String # 
Instance details

Defined in Text.Regex.TDFA.String

Methods

matchOnce :: Regex -> String -> Maybe MatchArray #

matchAll :: Regex -> String -> [MatchArray] #

matchCount :: Regex -> String -> Int #

matchTest :: Regex -> String -> Bool #

matchAllText :: Regex -> String -> [MatchText String] #

matchOnceText :: Regex -> String -> Maybe (String, MatchText String, String) #

RegexContext Regex ByteString ByteString # 
Instance details

Defined in Text.Regex.TDFA.ByteString

Methods

match :: Regex -> ByteString -> ByteString #

matchM :: MonadFail m => Regex -> ByteString -> m ByteString #

RegexContext Regex ByteString ByteString # 
Instance details

Defined in Text.Regex.TDFA.ByteString.Lazy

Methods

match :: Regex -> ByteString -> ByteString #

matchM :: MonadFail m => Regex -> ByteString -> m ByteString #

RegexContext Regex Text Text #

Since: 1.3.1

Instance details

Defined in Text.Regex.TDFA.Text

Methods

match :: Regex -> Text -> Text #

matchM :: MonadFail m => Regex -> Text -> m Text #

RegexContext Regex Text Text #

Since: 1.3.1

Instance details

Defined in Text.Regex.TDFA.Text.Lazy

Methods

match :: Regex -> Text -> Text #

matchM :: MonadFail m => Regex -> Text -> m Text #

RegexContext Regex String String # 
Instance details

Defined in Text.Regex.TDFA.String

Methods

match :: Regex -> String -> String #

matchM :: MonadFail m => Regex -> String -> m String #

RegexOptions Regex CompOption ExecOption # 
Instance details

Defined in Text.Regex.TDFA.Common

RegexMaker Regex CompOption ExecOption ByteString # 
Instance details

Defined in Text.Regex.TDFA.ByteString

Methods

makeRegex :: ByteString -> Regex #

makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex #

makeRegexM :: MonadFail m => ByteString -> m Regex #

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex #

RegexMaker Regex CompOption ExecOption ByteString # 
Instance details

Defined in Text.Regex.TDFA.ByteString.Lazy

Methods

makeRegex :: ByteString -> Regex #

makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex #

makeRegexM :: MonadFail m => ByteString -> m Regex #

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex #

RegexMaker Regex CompOption ExecOption Text #

Since: 1.3.1

Instance details

Defined in Text.Regex.TDFA.Text

Methods

makeRegex :: Text -> Regex #

makeRegexOpts :: CompOption -> ExecOption -> Text -> Regex #

makeRegexM :: MonadFail m => Text -> m Regex #

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Text -> m Regex #

RegexMaker Regex CompOption ExecOption Text #

Since: 1.3.1

Instance details

Defined in Text.Regex.TDFA.Text.Lazy

Methods

makeRegex :: Text -> Regex #

makeRegexOpts :: CompOption -> ExecOption -> Text -> Regex #

makeRegexM :: MonadFail m => Text -> m Regex #

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Text -> m Regex #

RegexMaker Regex CompOption ExecOption String # 
Instance details

Defined in Text.Regex.TDFA.String

Methods

makeRegex :: String -> Regex #

makeRegexOpts :: CompOption -> ExecOption -> String -> Regex #

makeRegexM :: MonadFail m => String -> m Regex #

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> String -> m Regex #

RegexMaker Regex CompOption ExecOption (Seq Char) # 
Instance details

Defined in Text.Regex.TDFA.Sequence

Methods

makeRegex :: Seq Char -> Regex #

makeRegexOpts :: CompOption -> ExecOption -> Seq Char -> Regex #

makeRegexM :: MonadFail m => Seq Char -> m Regex #

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Seq Char -> m Regex #

RegexLike Regex (Seq Char) # 
Instance details

Defined in Text.Regex.TDFA.Sequence

Methods

matchOnce :: Regex -> Seq Char -> Maybe MatchArray #

matchAll :: Regex -> Seq Char -> [MatchArray] #

matchCount :: Regex -> Seq Char -> Int #

matchTest :: Regex -> Seq Char -> Bool #

matchAllText :: Regex -> Seq Char -> [MatchText (Seq Char)] #

matchOnceText :: Regex -> Seq Char -> Maybe (Seq Char, MatchText (Seq Char), Seq Char) #

RegexContext Regex (Seq Char) (Seq Char) # 
Instance details

Defined in Text.Regex.TDFA.Sequence

Methods

match :: Regex -> Seq Char -> Seq Char #

matchM :: MonadFail m => Regex -> Seq Char -> m (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

Instances details
Read CompOption # 
Instance details

Defined in Text.Regex.TDFA.Common

Methods

readsPrec :: Int -> ReadS CompOption

readList :: ReadS [CompOption]

readPrec :: ReadPrec CompOption

readListPrec :: ReadPrec [CompOption]

Show CompOption # 
Instance details

Defined in Text.Regex.TDFA.Common

Methods

showsPrec :: Int -> CompOption -> ShowS

show :: CompOption -> String

showList :: [CompOption] -> ShowS

RegexOptions Regex CompOption ExecOption # 
Instance details

Defined in Text.Regex.TDFA.Common

RegexMaker Regex CompOption ExecOption ByteString # 
Instance details

Defined in Text.Regex.TDFA.ByteString

Methods

makeRegex :: ByteString -> Regex #

makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex #

makeRegexM :: MonadFail m => ByteString -> m Regex #

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex #

RegexMaker Regex CompOption ExecOption ByteString # 
Instance details

Defined in Text.Regex.TDFA.ByteString.Lazy

Methods

makeRegex :: ByteString -> Regex #

makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex #

makeRegexM :: MonadFail m => ByteString -> m Regex #

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex #

RegexMaker Regex CompOption ExecOption Text #

Since: 1.3.1

Instance details

Defined in Text.Regex.TDFA.Text

Methods

makeRegex :: Text -> Regex #

makeRegexOpts :: CompOption -> ExecOption -> Text -> Regex #

makeRegexM :: MonadFail m => Text -> m Regex #

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Text -> m Regex #

RegexMaker Regex CompOption ExecOption Text #

Since: 1.3.1

Instance details

Defined in Text.Regex.TDFA.Text.Lazy

Methods

makeRegex :: Text -> Regex #

makeRegexOpts :: CompOption -> ExecOption -> Text -> Regex #

makeRegexM :: MonadFail m => Text -> m Regex #

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Text -> m Regex #

RegexMaker Regex CompOption ExecOption String # 
Instance details

Defined in Text.Regex.TDFA.String

Methods

makeRegex :: String -> Regex #

makeRegexOpts :: CompOption -> ExecOption -> String -> Regex #

makeRegexM :: MonadFail m => String -> m Regex #

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> String -> m Regex #

RegexMaker Regex CompOption ExecOption (Seq Char) # 
Instance details

Defined in Text.Regex.TDFA.Sequence

Methods

makeRegex :: Seq Char -> Regex #

makeRegexOpts :: CompOption -> ExecOption -> Seq Char -> Regex #

makeRegexM :: MonadFail m => Seq Char -> m Regex #

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Seq Char -> m Regex #

data ExecOption #

Instances

Instances details
Read ExecOption # 
Instance details

Defined in Text.Regex.TDFA.Common

Methods

readsPrec :: Int -> ReadS ExecOption

readList :: ReadS [ExecOption]

readPrec :: ReadPrec ExecOption

readListPrec :: ReadPrec [ExecOption]

Show ExecOption # 
Instance details

Defined in Text.Regex.TDFA.Common

Methods

showsPrec :: Int -> ExecOption -> ShowS

show :: ExecOption -> String

showList :: [ExecOption] -> ShowS

RegexOptions Regex CompOption ExecOption # 
Instance details

Defined in Text.Regex.TDFA.Common

RegexMaker Regex CompOption ExecOption ByteString # 
Instance details

Defined in Text.Regex.TDFA.ByteString

Methods

makeRegex :: ByteString -> Regex #

makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex #

makeRegexM :: MonadFail m => ByteString -> m Regex #

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex #

RegexMaker Regex CompOption ExecOption ByteString # 
Instance details

Defined in Text.Regex.TDFA.ByteString.Lazy

Methods

makeRegex :: ByteString -> Regex #

makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex #

makeRegexM :: MonadFail m => ByteString -> m Regex #

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex #

RegexMaker Regex CompOption ExecOption Text #

Since: 1.3.1

Instance details

Defined in Text.Regex.TDFA.Text

Methods

makeRegex :: Text -> Regex #

makeRegexOpts :: CompOption -> ExecOption -> Text -> Regex #

makeRegexM :: MonadFail m => Text -> m Regex #

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Text -> m Regex #

RegexMaker Regex CompOption ExecOption Text #

Since: 1.3.1

Instance details

Defined in Text.Regex.TDFA.Text.Lazy

Methods

makeRegex :: Text -> Regex #

makeRegexOpts :: CompOption -> ExecOption -> Text -> Regex #

makeRegexM :: MonadFail m => Text -> m Regex #

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Text -> m Regex #

RegexMaker Regex CompOption ExecOption String # 
Instance details

Defined in Text.Regex.TDFA.String

Methods

makeRegex :: String -> Regex #

makeRegexOpts :: CompOption -> ExecOption -> String -> Regex #

makeRegexM :: MonadFail m => String -> m Regex #

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> String -> m Regex #

RegexMaker Regex CompOption ExecOption (Seq Char) # 
Instance details

Defined in Text.Regex.TDFA.Sequence

Methods

makeRegex :: Seq Char -> Regex #

makeRegexOpts :: CompOption -> ExecOption -> Seq Char -> Regex #

makeRegexM :: MonadFail m => Seq Char -> m Regex #

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Seq Char -> m Regex #

compile #

Arguments

:: CompOption

Flags (summed together)

-> ExecOption

Flags (summed together)

-> ByteString

The regular expression to compile

-> Either String Regex

Returns: the compiled regular expression

execute #

Arguments

:: Regex

Compiled regular expression

-> ByteString

ByteString to match against

-> Either String (Maybe MatchArray) 

regexec #

Arguments

:: Regex

Compiled regular expression

-> ByteString

ByteString to match against

-> Either String (Maybe (ByteString, ByteString, ByteString, [ByteString])) 

Orphan instances

RegexLike Regex ByteString # 
Instance details

Methods

matchOnce :: Regex -> ByteString -> Maybe MatchArray #

matchAll :: Regex -> ByteString -> [MatchArray] #

matchCount :: Regex -> ByteString -> Int #

matchTest :: Regex -> ByteString -> Bool #

matchAllText :: Regex -> ByteString -> [MatchText ByteString] #

matchOnceText :: Regex -> ByteString -> Maybe (ByteString, MatchText ByteString, ByteString) #

RegexContext Regex ByteString ByteString # 
Instance details

Methods

match :: Regex -> ByteString -> ByteString #

matchM :: MonadFail m => Regex -> ByteString -> m ByteString #

RegexMaker Regex CompOption ExecOption ByteString # 
Instance details

Methods

makeRegex :: ByteString -> Regex #

makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex #

makeRegexM :: MonadFail m => ByteString -> m Regex #

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex #