Data.Conduit.Parsers.Text.Parser

At the first look, Data.Binary.Conduit.Get module is very similar with Data.Binary.Get. The main differences between them are the following. While the Get from binary is a very custom monad, the local Get is ConduitM, which leads to easy integration in complicated format parsing. The Data.Binary.Get module does not have a function to create custom Get monad, this module provides getC. Unlike isolate from binary, local isolate does not "cut" bytes counter. While the binary's Get is MonadFail, which leads to very ugly errors handling in complicated cases, local Get is MonadError.

Documentation

class (MonadError e m_e, MonadError e' m_e') => MonadMapError e m_e e' m_e' | m_e -> e, m_e' -> e', m_e e' -> m_e', m_e' e -> m_e where

Minimal complete definition

mapError

Methods

mapError :: (e -> e') -> m_e a -> m_e' a

Instances

MonadMapError e (Either e) e' (Either e')

Methods

mapError :: (e -> e') -> Either e a -> Either e' a

Monad m => MonadMapError e (ExceptT e m) e' (ExceptT e' m)

Methods

mapError :: (e -> e') -> ExceptT e m a -> ExceptT e' m a

MonadMapError e m_e e' m_e' => MonadMapError e (ConduitM i o m_e) e' (ConduitM i o m_e')

Methods

mapError :: (e -> e') -> ConduitM i o m_e a -> ConduitM i o m_e' a

Monad m => MonadMapError e (GetC s i e m) e' (GetC s i e' m)

Methods

mapError :: (e -> e') -> GetC s i e m a -> GetC s i e' m a

(?=>>) :: (MonadMapError e m_e (Either e e') m_Either_e_e', MonadMapError Void m_Void (Either e e') m_Either_e_e', MonadMapError (Either e e') m_Either_e_e' e' m_e') => m_e a -> (e -> m_Void e') -> m_e' a infixl 1

(?>>) :: (MonadMapError () m_Unit (Maybe e) m_Maybe_e, MonadMapError Void m_Void (Maybe e) m_Maybe_e, MonadMapError (Maybe e) m_Maybe_e e m_e) => m_Unit a -> m_Void e -> m_e a infixl 1

class (DecodingState s, DecodingToken s ~ Text, DecodingTextRead s) => DefaultParsingState s

Instances

(DecodingState s, (~) * (DecodingToken s) Text, DecodingTextRead s) => DefaultParsingState s

type GetM s i o e m = ConduitM i o (GetC s i e m)

A ConduitM with internal transformers supposed to a binary deserialization.

type Parser e a = forall s o m. (DefaultParsingState s, Monad m) => GetM s Text o e m a

The shortening of GetM for the most common use case.

runParser :: Monad m => GetM TextOffset i o e m a -> ConduitM i o m (Either e a)

Run a decoder presented as a Get monad. Returns decoder result and consumed bytes count.

charsRead :: (DecodingState s, DecodingElemsRead s, Monad m) => GetM s i o e m Word64

Get the total number of bytes read to this point.

linesRead :: (DecodingState s, DecodingLinesRead s, Monad m) => GetM s i o e m Word64

Get the total number of bytes read to this point.

columnsRead :: (DecodingState s, DecodingColumnsRead s, Monad m) => GetM s i o e m Word64

Get the total number of bytes read to this point.

castParser :: (DecodingState s, DecodingToken s ~ Text, Monad m) => Parser a -> GetM s Text o (NonEmpty String) m a

Run the given Get monad from binary package and convert result into Get.

pCharIs :: Char -> Parser () Char

skipCharIs :: Char -> Parser () ()

pChar :: Parser () Char

pCharIsNot :: Char -> Parser () Char

satisfy :: (Char -> Bool) -> Parser () Char

satisfyWith :: (Char -> a) -> (a -> Bool) -> Parser () a

skip1 :: (Char -> Bool) -> Parser () ()

peekChar :: Parser e (Maybe Char)

peekChar' :: Parser e Char

pDigit :: Integral a => Parser () a

pHexDigit :: Integral a => Parser () a

pHexByte :: Parser () Word8

pLetter :: Parser () Char

pSpace :: Parser () Char

inClass :: String -> Char -> Bool

Match any character in a set.

vowel = inClass "aeiou"

Range notation is supported.

halfAlphabet = inClass "a-nA-N"

To add a literal '-' to a set, place it at the beginning or end of the string.

notInClass :: String -> Char -> Bool

Match any character not in a set.

pStringIs :: Text -> Parser () Text

skipStringIs :: Text -> Parser () ()

pAsciiIgnoringCaseIs :: Text -> Parser () Text

skipSpace :: Parser () ()

skipWhile :: (Char -> Bool) -> Parser e ()

scan :: s -> (s -> Char -> Maybe s) -> Parser e Text

runScanner :: s -> (s -> Char -> Maybe s) -> Parser e (Text, s)

pString :: Int -> Parser () Text

pStringWhile :: (Char -> Bool) -> Parser e Text

pStringWhile1 :: (Char -> Bool) -> Parser () Text

pStringTill :: (Char -> Bool) -> Parser e Text

pRemainingString :: Parser e Text

pRemainingLazyString :: Parser e Text

skipEndOfLine :: Parser () ()

isEndOfLine :: Char -> Bool

A predicate that matches either a carriage return '\r' or newline '\n' character.

isHorizontalSpace :: Char -> Bool

A predicate that matches either a space ' ' or horizontal tab '\t' character.

pDecimal :: Integral a => Parser () a

pHexadecimal :: (Integral a, Bits a) => Parser () a

pSignedDecimal :: Integral a => Parser () a

pSignedHexadecimal :: (Integral a, Bits a) => Parser () a

pDouble :: Parser () Double

pRational :: Fractional a => Parser () a

pScientific :: Parser () Scientific

choice :: Alternative f => [f a] -> f a

choice ps tries to apply the actions in the list ps in order, until one of them succeeds. Returns the value of the succeeding action.

count :: Monad m => Int -> m a -> m [a]

Apply the given action repeatedly, returning every result.

option'' :: (MonadPlus m_Unit, MonadMapError e m_e () m_Unit, MonadMapError () m_Unit e' m_e') => m_e a -> m_e' (Maybe a)

many'' :: (MonadPlus m_Unit, MonadMapError e m_e () m_Unit, MonadMapError () m_Unit e' m_e') => m_e a -> m_e' [a]

many1'' :: (MonadPlus m_Unit, MonadMapError e m_e () m_Unit, MonadMapError () m_Unit e m_e) => m_e a -> m_e (NonEmpty a)

manyTill'' :: (MonadPlus m_Unit, MonadMapError e' m_e' () m_Unit, MonadMapError () m_Unit e m_e) => m_e a -> m_e' b -> m_e [a]

sepBy'' :: (MonadPlus m_Unit, MonadMapError e m_e () m_Unit, MonadMapError () m_Unit e'' m_e'', MonadMapError e' m_e' () m_Unit, MonadMapError () m_Unit () m_Unit) => m_e a -> m_e' s -> m_e'' [a]

sepBy1'' :: (MonadPlus m_Unit, MonadMapError e m_e () m_Unit, MonadMapError () m_Unit e m_e, MonadMapError e' m_e' () m_Unit, MonadMapError () m_Unit () m_Unit) => m_e a -> m_e' s -> m_e (NonEmpty a)

skipMany'' :: (MonadPlus m_Unit, MonadMapError e m_e () m_Unit, MonadMapError () m_Unit e' m_e') => m_e a -> m_e' ()

skipMany1'' :: (MonadPlus m_Unit, MonadMapError e m_e () m_Unit, MonadMapError () m_Unit e m_e) => m_e a -> m_e ()

eitherP :: Alternative f => f a -> f b -> f (Either a b)

Combine two alternatives.

matchP :: (DecodingState s, Monoid (DecodingToken s), Monad m) => GetM s (DecodingToken s) o e m a -> GetM s (DecodingToken s) o e m (DecodingToken s, a)

tryP :: Monad m => GetM s i o e m a -> GetM s i o e m a

Leftover consumed input on error.

pEnum :: (Eq a, Ord a, Enum a, Bounded a, Show a) => Int -> Parser () a

endOfInput :: (DecodingState s, MonoFoldable (DecodingToken s), Monad m) => GetM s (DecodingToken s) o () m ()