Modulebinary-parser-0.5.7.6Haskell2010

BinaryParser

1 type
21 values

Packagebinary-parser-0.5.7.6
Exports22
LanguageHaskell2010
LicenceMIT
SourceBinaryParser.hs

newtypenewtype BinaryParser a

A highly-efficient parser specialised for strict ByteStrings.

Supports the roll-back and alternative branching on the basis of the Alternative interface.

Does not generate fancy error-messages, which contributes to its efficiency.

Instances7Monad, Functor, MonadFail, Applicative, Alternative, MonadPlus, …

Monad BinaryParserDefined in binary-parser-0.5.7.6 · BinaryParser
Functor BinaryParserDefined in binary-parser-0.5.7.6 · BinaryParser
MonadFail BinaryParserDefined in binary-parser-0.5.7.6 · BinaryParser
Applicative BinaryParserDefined in binary-parser-0.5.7.6 · BinaryParser
Alternative BinaryParserDefined in binary-parser-0.5.7.6 · BinaryParser
MonadPlus BinaryParserDefined in binary-parser-0.5.7.6 · BinaryParser
MonadError Text BinaryParserDefined in binary-parser-0.5.7.6 · BinaryParser

valuerun :: BinaryParser a -> ByteString -> Either Text a

Apply a parser to bytes.

valuefailure :: Text -> BinaryParser a

Fail with a message.

valuebyte :: BinaryParser Word8

Consume a single byte.

valuematchingByte :: (Word8 -> Either Text a) -> BinaryParser a

Consume a single byte, which satisfies the predicate.

valuebytesOfSize :: Int -> BinaryParser ByteString

Consume an amount of bytes.

valuebytesWhile :: (Word8 -> Bool) -> BinaryParser ByteString

Consume multiple bytes, which satisfy the predicate.

valueunitOfSize :: Int -> BinaryParser ()

Skip an amount of bytes.

valueunitOfBytes :: ByteString -> BinaryParser ()

Skip specific bytes, while failing if they don't match.

valueunitWhile :: (Word8 -> Bool) -> BinaryParser ()

Skip bytes, which satisfy the predicate.

valueremainders :: BinaryParser ByteString

Consume all the remaining bytes.

valuefold :: (a -> Word8 -> Maybe a) -> a -> BinaryParser a

Left-fold the bytes, terminating before the byte, on which the step function returns Nothing.

valueendOfInput :: BinaryParser ()

Fail if the input hasn't ended.

valuesized :: Int -> BinaryParser a -> BinaryParser a

Run a subparser passing it a chunk of the current input of the specified size.

Extras

8 declarations

valuestorableOfSize :: Storable a => Int -> BinaryParser a

Storable value of the given amount of bytes.

valuebeWord16 :: BinaryParser Word16

Big-endian word of 2 bytes.

valueleWord16 :: BinaryParser Word16

Little-endian word of 2 bytes.

valuebeWord32 :: BinaryParser Word32

Big-endian word of 4 bytes.

valueleWord32 :: BinaryParser Word32

Little-endian word of 4 bytes.

valuebeWord64 :: BinaryParser Word64

Big-endian word of 8 bytes.

valueleWord64 :: BinaryParser Word64

Little-endian word of 8 bytes.

valueasciiIntegral :: Integral a => BinaryParser a

Integral number encoded in ASCII.