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)

Contents

run the Parser
Parser methods

Synopsis

newtype Parser
data Result
value parse
value parseFeed
value hasMore
value byte
value anyByte
value bytes
value take
value takeWhile
value takeAll
value skip
value skipWhile
value skipAll
value takeStorable

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

newtypenewtype Parser byteArray a

Source#

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

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

Instances1Show

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

run the Parser

valueparse

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

Source#

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)

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

valuehasMore :: ByteArray byteArray => Parser byteArray Bool

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

valueanyByte :: ByteArray byteArray => Parser byteArray Word8

Source#

Get the next byte from the parser

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

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

Source#

Take @n bytes from the current position in the stream

valuetakeWhile

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

Source#

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

valuetakeAll :: ByteArray byteArray => Parser byteArray byteArray

Source#

Take the remaining bytes from the current position in the stream

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

Source#

Skip @n bytes from the current position in the stream

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

Source#

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

valueskipAll :: ByteArray byteArray => Parser byteArray ()

Source#

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

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

Source#

Take a storable from the current position in the stream