regex-pcre-builtin-0.95.1.1.8.44: PCRE Backend for "Text.Regex" (regex-base)

Safe HaskellNone
LanguageHaskell2010

Text.Regex.PCRE.ByteString

Contents

Description

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

Synopsis

Types

data Regex Source #

A compiled regular expression

Instances
RegexLike Regex String Source # 
Instance details

Defined in Text.Regex.PCRE.String

RegexLike Regex ByteString Source # 
Instance details

Defined in Text.Regex.PCRE.ByteString.Lazy

RegexLike Regex ByteString Source # 
Instance details

Defined in Text.Regex.PCRE.ByteString

RegexLike Regex Text Source # 
Instance details

Defined in Text.Regex.PCRE.Text.Lazy

RegexLike Regex Text Source # 
Instance details

Defined in Text.Regex.PCRE.Text

RegexOptions Regex CompOption ExecOption Source # 
Instance details

Defined in Text.Regex.PCRE.Wrap

RegexContext Regex String String Source # 
Instance details

Defined in Text.Regex.PCRE.String

Methods

match :: Regex -> String -> String #

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

RegexContext Regex ByteString ByteString Source # 
Instance details

Defined in Text.Regex.PCRE.ByteString.Lazy

RegexContext Regex ByteString ByteString Source # 
Instance details

Defined in Text.Regex.PCRE.ByteString

RegexContext Regex Text Text Source # 
Instance details

Defined in Text.Regex.PCRE.Text.Lazy

Methods

match :: Regex -> Text -> Text #

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

RegexContext Regex Text Text Source # 
Instance details

Defined in Text.Regex.PCRE.Text

Methods

match :: Regex -> Text -> Text #

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

RegexMaker Regex CompOption ExecOption String Source # 
Instance details

Defined in Text.Regex.PCRE.String

RegexMaker Regex CompOption ExecOption ByteString Source # 
Instance details

Defined in Text.Regex.PCRE.ByteString.Lazy

RegexMaker Regex CompOption ExecOption ByteString Source # 
Instance details

Defined in Text.Regex.PCRE.ByteString

RegexMaker Regex CompOption ExecOption Text Source # 
Instance details

Defined in Text.Regex.PCRE.Text.Lazy

RegexMaker Regex CompOption ExecOption Text Source # 
Instance details

Defined in Text.Regex.PCRE.Text

RegexMaker Regex CompOption ExecOption (Seq Char) Source # 
Instance details

Defined in Text.Regex.PCRE.Sequence

RegexLike Regex (Seq Char) Source # 
Instance details

Defined in Text.Regex.PCRE.Sequence

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

Defined in Text.Regex.PCRE.Sequence

Methods

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

matchM :: MonadFail m => Regex -> Seq Char -> m (Seq Char) #

type MatchOffset = Int #

0 based index from start of source, or (-1) for unused

type MatchLength = Int #

non-negative length of a match

newtype CompOption Source #

Constructors

CompOption CInt 
Instances
Eq CompOption Source # 
Instance details

Defined in Text.Regex.PCRE.Wrap

Num CompOption Source # 
Instance details

Defined in Text.Regex.PCRE.Wrap

Show CompOption Source # 
Instance details

Defined in Text.Regex.PCRE.Wrap

Bits CompOption Source # 
Instance details

Defined in Text.Regex.PCRE.Wrap

RegexOptions Regex CompOption ExecOption Source # 
Instance details

Defined in Text.Regex.PCRE.Wrap

RegexMaker Regex CompOption ExecOption String Source # 
Instance details

Defined in Text.Regex.PCRE.String

RegexMaker Regex CompOption ExecOption ByteString Source # 
Instance details

Defined in Text.Regex.PCRE.ByteString.Lazy

RegexMaker Regex CompOption ExecOption ByteString Source # 
Instance details

Defined in Text.Regex.PCRE.ByteString

RegexMaker Regex CompOption ExecOption Text Source # 
Instance details

Defined in Text.Regex.PCRE.Text.Lazy

RegexMaker Regex CompOption ExecOption Text Source # 
Instance details

Defined in Text.Regex.PCRE.Text

RegexMaker Regex CompOption ExecOption (Seq Char) Source # 
Instance details

Defined in Text.Regex.PCRE.Sequence

newtype ExecOption Source #

Constructors

ExecOption CInt 
Instances
Eq ExecOption Source # 
Instance details

Defined in Text.Regex.PCRE.Wrap

Num ExecOption Source # 
Instance details

Defined in Text.Regex.PCRE.Wrap

Show ExecOption Source # 
Instance details

Defined in Text.Regex.PCRE.Wrap

Bits ExecOption Source # 
Instance details

Defined in Text.Regex.PCRE.Wrap

RegexOptions Regex CompOption ExecOption Source # 
Instance details

Defined in Text.Regex.PCRE.Wrap

RegexMaker Regex CompOption ExecOption String Source # 
Instance details

Defined in Text.Regex.PCRE.String

RegexMaker Regex CompOption ExecOption ByteString Source # 
Instance details

Defined in Text.Regex.PCRE.ByteString.Lazy

RegexMaker Regex CompOption ExecOption ByteString Source # 
Instance details

Defined in Text.Regex.PCRE.ByteString

RegexMaker Regex CompOption ExecOption Text Source # 
Instance details

Defined in Text.Regex.PCRE.Text.Lazy

RegexMaker Regex CompOption ExecOption Text Source # 
Instance details

Defined in Text.Regex.PCRE.Text

RegexMaker Regex CompOption ExecOption (Seq Char) Source # 
Instance details

Defined in Text.Regex.PCRE.Sequence

data ReturnCode Source #

Instances
Eq ReturnCode Source # 
Instance details

Defined in Text.Regex.PCRE.Wrap

Show ReturnCode Source # 
Instance details

Defined in Text.Regex.PCRE.Wrap

Miscellaneous

getVersion :: Maybe String Source #

Version string of PCRE library

NOTE: The Maybe type is used for historic reasons; practically, getVersion is never Nothing.

Medium level API functions

compile Source #

Arguments

:: CompOption

(summed together)

-> ExecOption

(summed together)

-> ByteString

The regular expression to compile

-> IO (Either (MatchOffset, String) Regex)

Returns: the compiled regular expression

Compiles a regular expression

execute Source #

Arguments

:: Regex

Compiled regular expression

-> ByteString

String to match against

-> IO (Either WrapError (Maybe (Array Int (MatchOffset, MatchLength))))

Returns: Nothing if the regex did not match the string, or: Just an array of (offset,length) pairs where index 0 is whole match, and the rest are the captured subexpressions.

Matches a regular expression against a buffer, returning the buffer indicies of the match, and any submatches

| Matches a regular expression against a string

regexec Source #

Arguments

:: Regex

Compiled regular expression

-> ByteString

String to match against

-> IO (Either WrapError (Maybe (ByteString, ByteString, ByteString, [ByteString]))) 

CompOption flags

ExecOption flags

Orphan instances