megaparsec/Text/MegaParsec/ByteString/Lazy.hs

49 lines
1.4 KiB
Haskell
Raw Normal View History

2015-07-28 16:32:19 +03:00
-- |
-- Module : Text.MegaParsec.ByteString.Lazy
-- Copyright : © 2015 MegaParsec contributors
-- © 2007 Paolo Martini
2015-07-28 16:32:19 +03:00
-- License : BSD3
--
-- Maintainer : Mark Karpov <markkarpov@opmbx.org>
2015-07-29 11:38:32 +03:00
-- Stability : experimental
2015-07-28 16:32:19 +03:00
-- Portability : portable
--
-- Convenience definitions for working with lazy 'C.ByteString's.
module Text.MegaParsec.ByteString.Lazy
( Parser
, GenParser
, parseFromFile )
where
import Text.MegaParsec.Error
import Text.MegaParsec.Prim
import qualified Data.ByteString.Lazy.Char8 as C
2015-07-30 21:36:54 +03:00
-- | Different modules corresponding to various types of streams (@String@,
-- @Text@, @ByteString@) define it differently, so user can use \"abstract\"
-- @Parser@ type and easily change it by importing different \"type
-- modules\".
type Parser = Parsec C.ByteString ()
-- | @GenParser@ is similar to @Parser@ but it's parametrized over user
-- state type.
2015-07-28 16:32:19 +03:00
type GenParser t st = Parsec C.ByteString st
-- | @parseFromFile p filePath@ runs a lazy bytestring parser @p@ on the
-- input read from @filePath@ using
-- 'ByteString.Lazy.Char8.readFile'. Returns either a 'ParseError' ('Left')
-- or a value of type @a@ ('Right').
--
2015-07-29 11:38:32 +03:00
-- > main = do
-- > result <- parseFromFile numbers "digits.txt"
-- > case result of
-- > Left err -> print err
-- > Right xs -> print (sum xs)
2015-07-28 16:32:19 +03:00
parseFromFile :: Parser a -> String -> IO (Either ParseError a)
2015-07-30 18:45:06 +03:00
parseFromFile p fname = runParser p () fname <$> C.readFile fname