memory-0.15.0: memory and related abstraction stuff
LicenseBSD-style
MaintainerVincent Hanquez <vincent@snarc.org>
Stabilityexperimental
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Data.ByteArray.Parse

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

Documentation

data Parser byteArray a Source #

Simple ByteString parser structure

Instances

Instances details
Monad (Parser byteArray) Source # 
Instance details

Defined in Data.ByteArray.Parse

Methods

(>>=) :: Parser byteArray a -> (a -> Parser byteArray b) -> Parser byteArray b Source #

(>>) :: Parser byteArray a -> Parser byteArray b -> Parser byteArray b Source #

return :: a -> Parser byteArray a Source #

Functor (Parser byteArray) Source # 
Instance details

Defined in Data.ByteArray.Parse

Methods

fmap :: (a -> b) -> Parser byteArray a -> Parser byteArray b Source #

(<$) :: a -> Parser byteArray b -> Parser byteArray a Source #

MonadFail (Parser byteArray) Source # 
Instance details

Defined in Data.ByteArray.Parse

Methods

fail :: String -> Parser byteArray a Source #

Applicative (Parser byteArray) Source # 
Instance details

Defined in Data.ByteArray.Parse

Methods

pure :: a -> Parser byteArray a Source #

(<*>) :: Parser byteArray (a -> b) -> Parser byteArray a -> Parser byteArray b Source #

liftA2 :: (a -> b -> c) -> Parser byteArray a -> Parser byteArray b -> Parser byteArray c Source #

(*>) :: Parser byteArray a -> Parser byteArray b -> Parser byteArray b Source #

(<*) :: Parser byteArray a -> Parser byteArray b -> Parser byteArray a Source #

Alternative (Parser byteArray) Source # 
Instance details

Defined in Data.ByteArray.Parse

Methods

empty :: Parser byteArray a Source #

(<|>) :: Parser byteArray a -> Parser byteArray a -> Parser byteArray a Source #

some :: Parser byteArray a -> Parser byteArray [a] Source #

many :: Parser byteArray a -> Parser byteArray [a] Source #

MonadPlus (Parser byteArray) Source # 
Instance details

Defined in Data.ByteArray.Parse

Methods

mzero :: Parser byteArray a Source #

mplus :: Parser byteArray a -> Parser byteArray a -> Parser byteArray a Source #

data Result byteArray a Source #

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) Source # 
Instance details

Defined in Data.ByteArray.Parse

Methods

showsPrec :: Int -> Result ba a -> ShowS Source #

show :: Result ba a -> String Source #

showList :: [Result ba a] -> ShowS Source #

run the Parser

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

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) Source #

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 Source #

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

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 Source #

Get the next byte from the parser

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

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 Source #

Take @n bytes from the current position in the stream

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

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

takeAll :: ByteArray byteArray => Parser byteArray byteArray Source #

Take the remaining bytes from the current position in the stream

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

Skip @n bytes from the current position in the stream

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

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

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

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

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

Take a storable from the current position in the stream