Text.RE.Types.Capture

Documentation

data Capture a

the matching of a single sub-expression against part of the source text

Constructors

Capture

Fields

• captureSource :: !a

  the whole text that was searched

• capturedText :: !a

  the text that was matched

• captureOffset :: !Int

  the number of characters preceding the match with -1 used if no text was captured by the RE (not even the empty string)

• captureLength :: !Int

  the number of chacter in the captured sub-string

Instances

Functor Capture

Methods

fmap :: (a -> b) -> Capture a -> Capture b

(<$) :: a -> Capture b -> Capture a

Eq a => Eq (Capture a)

Methods

(==) :: Capture a -> Capture a -> Bool

(/=) :: Capture a -> Capture a -> Bool

Show a => Show (Capture a)

Methods

showsPrec :: Int -> Capture a -> ShowS

show :: Capture a -> String

showList :: [Capture a] -> ShowS

hasCaptured :: Capture a -> Bool

test if the capture has matched any text

capturePrefix :: Extract a => Capture a -> a

returns the text preceding the match

captureSuffix :: Extract a => Capture a -> a

returns the text after the match