Moduleram-0.22.1Haskell2010

Data.ByteArray.Parse

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)

2 types
13 values

Packageram-0.22.1
Exports15
LanguageHaskell2010
LicenceBSD-3-Clause
SourceParse.hs

newtypenewtype Parser byteArray a

Simple ByteString parser structure

Instances6Monad, Functor, MonadFail, Applicative, Alternative, MonadPlus

Monad (Parser byteArray)Defined in ram-0.22.1 · Data.ByteArray.Parse
Functor (Parser byteArray)Defined in ram-0.22.1 · Data.ByteArray.Parse
MonadFail (Parser byteArray)Defined in ram-0.22.1 · Data.ByteArray.Parse
Applicative (Parser byteArray)Defined in ram-0.22.1 · Data.ByteArray.Parse
Alternative (Parser byteArray)Defined in ram-0.22.1 · Data.ByteArray.Parse
MonadPlus (Parser byteArray)Defined in ram-0.22.1 · Data.ByteArray.Parse

datadata 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

Instances1Show

(Show ba, Show a) => Show (Result ba a)Defined in ram-0.22.1 · Data.ByteArray.Parse

run the Parser

2 declarations

valueparse

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

Run a Parser on a ByteString and return a Result

valueparseFeed

:: (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

11 declarations

valuehasMore :: ByteArray byteArray => Parser byteArray Bool

valuebyte :: 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.

valueanyByte :: ByteArray byteArray => Parser byteArray Word8

Get the next byte from the parser

valuebytes :: (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

valuetake :: ByteArray byteArray => Int -> Parser byteArray byteArray

Take @n bytes from the current position in the stream

valuetakeWhile

:: ByteArray byteArray
=> Word8 -> Bool
-> Parser byteArray byteArray

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

valuetakeAll :: ByteArray byteArray => Parser byteArray byteArray

Take the remaining bytes from the current position in the stream

valueskip :: ByteArray byteArray => Int -> Parser byteArray ()

Skip @n bytes from the current position in the stream

valueskipWhile :: ByteArray byteArray => (Word8 -> Bool) -> Parser byteArray ()

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

valueskipAll :: ByteArray byteArray => Parser byteArray ()

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

valuetakeStorable :: (ByteArray byteArray, Storable d) => Parser byteArray d

Take a storable from the current position in the stream