Data.ByteArray.Parse

memory-0.18.0: memory and related abstraction stuff

License | BSD-style
Maintainer | Vincent Hanquez <vincent@snarc.org>
Stability | experimental
Portability | portable
Safe Haskell | Safe-Inferred
Language | Haskell2010

Data.ByteArray.Parse

Contents

- run the Parser
- Parser methods

Description

A very simple bytearray parser related to Parsec and Attoparsec

Simple example:

    > parse ((,,) <$> take 2 <*> byte 0x20 <*> (bytes "abc" *> anyByte)) "xx abctest"
    ParseOK "est" ("xx", 116)

Synopsis

- data Parser byteArray a
- data Result byteArray a
  - = ParseFail String
  - | ParseMore (Maybe byteArray -> Result byteArray a)
  - | ParseOK byteArray a
- parse :: ByteArrayAccess byteArray => Parser byteArray a -> byteArray -> Result byteArray a
- parseFeed :: (ByteArrayAccess byteArray, Monad m) => m (Maybe byteArray) -> Parser byteArray a -> byteArray -> m (Result byteArray a)
- hasMore :: ByteArray byteArray => Parser byteArray Bool
- byte :: ByteArray byteArray => Word8 -> Parser byteArray ()
- anyByte :: ByteArray byteArray => Parser byteArray Word8
- bytes :: (Show ba, Eq ba, ByteArray ba) => ba -> Parser ba ()
- take :: ByteArray byteArray => Int -> Parser byteArray byteArray
- takeWhile :: ByteArray byteArray => (Word8 -> Bool) -> Parser byteArray byteArray
- takeAll :: ByteArray byteArray => Parser byteArray byteArray
- skip :: ByteArray byteArray => Int -> Parser byteArray ()
- skipWhile :: ByteArray byteArray => (Word8 -> Bool) -> Parser byteArray ()
- skipAll :: ByteArray byteArray => Parser byteArray ()
- takeStorable :: (ByteArray byteArray, Storable d) => Parser byteArray d

# Documentation

data Parser byteArray a #

Simple ByteString parser structure

#### Instances

Instances details

MonadFail (Parser byteArray) # |
Instance details Defined in Data.ByteArray.Parse Methods fail :: String -> Parser byteArray a
Alternative (Parser byteArray) # |
Instance details Defined in Data.ByteArray.Parse Methods empty :: Parser byteArray a (<|>) :: Parser byteArray a -> Parser byteArray a -> Parser byteArray a some :: Parser byteArray a -> Parser byteArray [a] many :: Parser byteArray a -> Parser byteArray [a]
Applicative (Parser byteArray) # |
Instance details Defined in Data.ByteArray.Parse Methods pure :: a -> Parser byteArray a # (<*>) :: Parser byteArray (a -> b) -> Parser byteArray a -> Parser byteArray b # liftA2 :: (a -> b -> c) -> Parser byteArray a -> Parser byteArray b -> Parser byteArray c # (*>) :: Parser byteArray a -> Parser byteArray b -> Parser byteArray b # (<*) :: Parser byteArray a -> Parser byteArray b -> Parser byteArray a #
Functor (Parser byteArray) # |
Instance details Defined in Data.ByteArray.Parse Methods fmap :: (a -> b) -> Parser byteArray a -> Parser byteArray b # (<$) :: a -> Parser byteArray b -> Parser byteArray a #
Monad (Parser byteArray) # |
Instance details Defined in Data.ByteArray.Parse Methods (>>=) :: Parser byteArray a -> (a -> Parser byteArray b) -> Parser byteArray b # (>>) :: Parser byteArray a -> Parser byteArray b -> Parser byteArray b # return :: a -> Parser byteArray a #
MonadPlus (Parser byteArray) # |
Instance details Defined in Data.ByteArray.Parse Methods mzero :: Parser byteArray a mplus :: Parser byteArray a -> Parser byteArray a -> Parser byteArray a

data Result byteArray a #

Simple parsing result, that represent respectively:

- failure: with the error message
- continuation: that need for more input data
- success: the remaining unparsed data and the parser value

Constructors

ParseFail String |
ParseMore (Maybe byteArray -> Result byteArray a) |
ParseOK byteArray a |

#### Instances

Instances details

(Show ba, Show a) => Show (Result ba a) # |
Instance details Defined in Data.ByteArray.Parse Methods showsPrec :: Int -> Result ba a -> ShowS # show :: Result ba a -> String # showList :: [Result ba a] -> ShowS #

# run the Parser

parse :: ByteArrayAccess byteArray => Parser byteArray a -> byteArray -> Result byteArray a #

Run a Parser on a ByteString and return a `Result`

parseFeed :: (ByteArrayAccess byteArray, Monad m) => m (Maybe byteArray) -> Parser byteArray a -> byteArray -> m (Result byteArray a) #

Run a parser on an @initial byteArray.

If the Parser need more data than available, the @feeder function is automatically called and fed to the More continuation.

# Parser methods

hasMore :: ByteArray byteArray => Parser byteArray Bool #

byte :: ByteArray byteArray => Word8 -> Parser byteArray () #

Parse a specific byte at current position

if the byte is different than the expected on, this parser will raise a failure.

anyByte :: ByteArray byteArray => Parser byteArray Word8 #

Get the next byte from the parser

bytes :: (Show ba, Eq ba, ByteArray ba) => ba -> Parser ba () #

Parse a sequence of bytes from current position

if the following bytes don't match the expected bytestring completely, the parser will raise a failure

take :: ByteArray byteArray => Int -> Parser byteArray byteArray #

Take @n bytes from the current position in the stream

takeWhile :: ByteArray byteArray => (Word8 -> Bool) -> Parser byteArray byteArray #

Take bytes while the @predicate hold from the current position in the stream

takeAll :: ByteArray byteArray => Parser byteArray byteArray #

Take the remaining bytes from the current position in the stream

skip :: ByteArray byteArray => Int -> Parser byteArray () #

Skip @n bytes from the current position in the stream

skipWhile :: ByteArray byteArray => (Word8 -> Bool) -> Parser byteArray () #

Skip bytes while the @predicate hold from the current position in the stream

skipAll :: ByteArray byteArray => Parser byteArray () #

Skip all the remaining bytes from the current position in the stream

takeStorable :: (ByteArray byteArray, Storable d) => Parser byteArray d #

Take a storable from the current position in the stream