| Safe Haskell | None |
|---|---|
| Language | Haskell98 |
Text.Regex.PCRE.ByteString.Lazy
Contents
Description
- data Regex
- type MatchOffset = Int
- type MatchLength = Int
- newtype CompOption = CompOption CInt
- newtype ExecOption = ExecOption CInt
- data ReturnCode
- type WrapError = (ReturnCode, String)
- unusedOffset :: MatchOffset
- getVersion :: Maybe String
- compile :: CompOption -> ExecOption -> ByteString -> IO (Either (MatchOffset, String) Regex)
- execute :: Regex -> ByteString -> IO (Either WrapError (Maybe (Array Int (MatchOffset, MatchLength))))
- regexec :: Regex -> ByteString -> IO (Either WrapError (Maybe (ByteString, ByteString, ByteString, [ByteString])))
- compBlank :: CompOption
- compAnchored :: CompOption
- compAutoCallout :: CompOption
- compCaseless :: CompOption
- compDollarEndOnly :: CompOption
- compDotAll :: CompOption
- compExtended :: CompOption
- compExtra :: CompOption
- compFirstLine :: CompOption
- compMultiline :: CompOption
- compNoAutoCapture :: CompOption
- compUngreedy :: CompOption
- compUTF8 :: CompOption
- compNoUTF8Check :: CompOption
- execBlank :: ExecOption
- execAnchored :: ExecOption
- execNotBOL :: ExecOption
- execNotEOL :: ExecOption
- execNotEmpty :: ExecOption
- execNoUTF8Check :: ExecOption
- execPartial :: ExecOption
Types
type MatchOffset = Int #
0 based index from start of source, or (-1) for unused
type MatchLength = Int #
non-negative length of a match
data ReturnCode #
Instances
type WrapError = (ReturnCode, String) #
Miscellaneous
getVersion :: Maybe String #
return version of pcre used or Nothing if pcre is not available.
Medium level API functions
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
Arguments
| :: Regex | Compiled regular expression |
| -> ByteString | String to match against |
| -> IO (Either WrapError (Maybe (Array Int (MatchOffset, MatchLength)))) | Returns: |
Matches a regular expression against a buffer, returning the buffer indicies of the match, and any submatches
| Matches a regular expression against a string
Arguments
| :: Regex | Compiled regular expression |
| -> ByteString | String to match against |
| -> IO (Either WrapError (Maybe (ByteString, ByteString, ByteString, [ByteString]))) |
CompOption flags
compBlank :: CompOption #
compExtra :: CompOption #
compUTF8 :: CompOption #
ExecOption flags
execBlank :: ExecOption #