Data.Bytes.Get

This module generalizes the binary Get and cereal Get monads in an ad hoc fashion to permit code to be written that is compatible across them.

Moreover, this class permits code to be written to be portable over various monad transformers applied to these as base monads.

Documentation

class (Integral (Remaining m), Monad m, Applicative m) => MonadGet m where

Minimal complete definition

lookAhead, lookAheadM, lookAheadE

Associated Types

type Remaining m :: *

An Integral number type used for unchecked skips and counting.

type Bytes m :: *

The underlying ByteString type used by this instance

Methods

skip :: Int -> m ()

Skip ahead n bytes. Fails if fewer than n bytes are available.

skip :: (MonadTrans t, MonadGet n, m ~ t n) => Int -> m ()

Skip ahead n bytes. Fails if fewer than n bytes are available.

ensure :: Int -> m ByteString

If at least n bytes are available return at least that much of the current input. Otherwise fail.

ensure :: (MonadTrans t, MonadGet n, m ~ t n) => Int -> m ByteString

If at least n bytes are available return at least that much of the current input. Otherwise fail.

lookAhead :: m a -> m a

Run ga, but return without consuming its input. Fails if ga fails.

lookAheadM :: m (Maybe a) -> m (Maybe a)

Like lookAhead, but consume the input if gma returns 'Just _'. Fails if gma fails.

lookAheadE :: m (Either a b) -> m (Either a b)

Like lookAhead, but consume the input if gea returns 'Right _'. Fails if gea fails.

getBytes :: Int -> m ByteString

Pull n bytes from the input, as a strict ByteString.

getBytes :: (MonadTrans t, MonadGet n, m ~ t n) => Int -> m ByteString

Pull n bytes from the input, as a strict ByteString.

remaining :: m (Remaining m)

Get the number of remaining unparsed bytes. Useful for checking whether all input has been consumed. Note that this forces the rest of the input.

remaining :: (MonadTrans t, MonadGet n, m ~ t n, Remaining m ~ Remaining n) => m (Remaining m)

Get the number of remaining unparsed bytes. Useful for checking whether all input has been consumed. Note that this forces the rest of the input.

isEmpty :: m Bool

Test whether all input has been consumed, i.e. there are no remaining unparsed bytes.

isEmpty :: (MonadTrans t, MonadGet n, m ~ t n) => m Bool

Test whether all input has been consumed, i.e. there are no remaining unparsed bytes.

getWord8 :: m Word8

Read a Word8 from the monad state

getWord8 :: (MonadTrans t, MonadGet n, m ~ t n) => m Word8

Read a Word8 from the monad state

getByteString :: Int -> m ByteString

An efficient get method for strict ByteStrings. Fails if fewer than n bytes are left in the input.

getByteString :: (MonadTrans t, MonadGet n, m ~ t n) => Int -> m ByteString

An efficient get method for strict ByteStrings. Fails if fewer than n bytes are left in the input.

getLazyByteString :: Int64 -> m ByteString

An efficient get method for lazy ByteStrings. Does not fail if fewer than n bytes are left in the input.

getLazyByteString :: (MonadTrans t, MonadGet n, m ~ t n) => Int64 -> m ByteString

An efficient get method for lazy ByteStrings. Does not fail if fewer than n bytes are left in the input.

getWord16be :: m Word16

Read a Word16 in big endian format

getWord16be :: (MonadTrans t, MonadGet n, m ~ t n) => m Word16

Read a Word16 in big endian format

getWord16le :: m Word16

Read a Word16 in little endian format

getWord16le :: (MonadTrans t, MonadGet n, m ~ t n) => m Word16

Read a Word16 in little endian format

getWord16host :: m Word16

O(1). Read a 2 byte Word16 in native host order and host endianness.

getWord16host :: (MonadTrans t, MonadGet n, m ~ t n) => m Word16

O(1). Read a 2 byte Word16 in native host order and host endianness.

getWord32be :: m Word32

Read a Word32 in big endian format

getWord32be :: (MonadTrans t, MonadGet n, m ~ t n) => m Word32

Read a Word32 in big endian format

getWord32le :: m Word32

Read a Word32 in little endian format

getWord32le :: (MonadTrans t, MonadGet n, m ~ t n) => m Word32

Read a Word32 in little endian format

getWord32host :: m Word32

O(1). Read a Word32 in native host order and host endianness.

getWord32host :: (MonadTrans t, MonadGet n, m ~ t n) => m Word32

O(1). Read a Word32 in native host order and host endianness.

getWord64be :: m Word64

Read a Word64 in big endian format

getWord64be :: (MonadTrans t, MonadGet n, m ~ t n) => m Word64

Read a Word64 in big endian format

getWord64le :: m Word64

Read a Word64 in little endian format

getWord64le :: (MonadTrans t, MonadGet n, m ~ t n) => m Word64

Read a Word64 in little endian format

getWord64host :: m Word64

O(1). Read a Word64 in native host order and host endianness.

getWord64host :: (MonadTrans t, MonadGet n, m ~ t n) => m Word64

O(1). Read a Word64 in native host order and host endianness.

getWordhost :: m Word

O(1). Read a single native machine word. The word is read in host order, host endian form, for the machine you're on. On a 64 bit machine the Word is an 8 byte value, on a 32 bit machine, 4 bytes.

getWordhost :: (MonadTrans t, MonadGet n, m ~ t n) => m Word

O(1). Read a single native machine word. The word is read in host order, host endian form, for the machine you're on. On a 64 bit machine the Word is an 8 byte value, on a 32 bit machine, 4 bytes.

Instances

MonadGet Get

Defined in Data.Bytes.Get

Associated Types

type Remaining Get :: *

type Bytes Get :: *

Methods

skip :: Int -> Get ()

ensure :: Int -> Get ByteString

lookAhead :: Get a -> Get a

lookAheadM :: Get (Maybe a) -> Get (Maybe a)

lookAheadE :: Get (Either a b) -> Get (Either a b)

getBytes :: Int -> Get ByteString

remaining :: Get (Remaining Get)

isEmpty :: Get Bool

getWord8 :: Get Word8

getByteString :: Int -> Get ByteString

getLazyByteString :: Int64 -> Get ByteString

getWord16be :: Get Word16

getWord16le :: Get Word16

getWord16host :: Get Word16

getWord32be :: Get Word32

getWord32le :: Get Word32

getWord32host :: Get Word32

getWord64be :: Get Word64

getWord64le :: Get Word64

getWord64host :: Get Word64

getWordhost :: Get Word

MonadGet Get

Defined in Data.Bytes.Get

Associated Types

type Remaining Get :: *

type Bytes Get :: *

Methods

skip :: Int -> Get ()

ensure :: Int -> Get ByteString

lookAhead :: Get a -> Get a

lookAheadM :: Get (Maybe a) -> Get (Maybe a)

lookAheadE :: Get (Either a b) -> Get (Either a b)

getBytes :: Int -> Get ByteString

remaining :: Get (Remaining Get)

isEmpty :: Get Bool

getWord8 :: Get Word8

getByteString :: Int -> Get ByteString

getLazyByteString :: Int64 -> Get ByteString

getWord16be :: Get Word16

getWord16le :: Get Word16

getWord16host :: Get Word16

getWord32be :: Get Word32

getWord32le :: Get Word32

getWord32host :: Get Word32

getWord64be :: Get Word64

getWord64le :: Get Word64

getWord64host :: Get Word64

getWordhost :: Get Word

MonadGet m => MonadGet (ExceptT e m)

Defined in Data.Bytes.Get

Associated Types

type Remaining (ExceptT e m) :: *

type Bytes (ExceptT e m) :: *

Methods

skip :: Int -> ExceptT e m ()

ensure :: Int -> ExceptT e m ByteString

lookAhead :: ExceptT e m a -> ExceptT e m a

lookAheadM :: ExceptT e m (Maybe a) -> ExceptT e m (Maybe a)

lookAheadE :: ExceptT e m (Either a b) -> ExceptT e m (Either a b)

getBytes :: Int -> ExceptT e m ByteString

remaining :: ExceptT e m (Remaining (ExceptT e m))

isEmpty :: ExceptT e m Bool

getWord8 :: ExceptT e m Word8

getByteString :: Int -> ExceptT e m ByteString

getLazyByteString :: Int64 -> ExceptT e m ByteString

getWord16be :: ExceptT e m Word16

getWord16le :: ExceptT e m Word16

getWord16host :: ExceptT e m Word16

getWord32be :: ExceptT e m Word32

getWord32le :: ExceptT e m Word32

getWord32host :: ExceptT e m Word32

getWord64be :: ExceptT e m Word64

getWord64le :: ExceptT e m Word64

getWord64host :: ExceptT e m Word64

getWordhost :: ExceptT e m Word

MonadGet m => MonadGet (StateT s m)

Defined in Data.Bytes.Get

Associated Types

type Remaining (StateT s m) :: *

type Bytes (StateT s m) :: *

Methods

skip :: Int -> StateT s m ()

ensure :: Int -> StateT s m ByteString

lookAhead :: StateT s m a -> StateT s m a

lookAheadM :: StateT s m (Maybe a) -> StateT s m (Maybe a)

lookAheadE :: StateT s m (Either a b) -> StateT s m (Either a b)

getBytes :: Int -> StateT s m ByteString

remaining :: StateT s m (Remaining (StateT s m))

isEmpty :: StateT s m Bool

getWord8 :: StateT s m Word8

getByteString :: Int -> StateT s m ByteString

getLazyByteString :: Int64 -> StateT s m ByteString

getWord16be :: StateT s m Word16

getWord16le :: StateT s m Word16

getWord16host :: StateT s m Word16

getWord32be :: StateT s m Word32

getWord32le :: StateT s m Word32

getWord32host :: StateT s m Word32

getWord64be :: StateT s m Word64

getWord64le :: StateT s m Word64

getWord64host :: StateT s m Word64

getWordhost :: StateT s m Word

MonadGet m => MonadGet (StateT s m)

Defined in Data.Bytes.Get

Associated Types

type Remaining (StateT s m) :: *

type Bytes (StateT s m) :: *

Methods

skip :: Int -> StateT s m ()

ensure :: Int -> StateT s m ByteString

lookAhead :: StateT s m a -> StateT s m a

lookAheadM :: StateT s m (Maybe a) -> StateT s m (Maybe a)

lookAheadE :: StateT s m (Either a b) -> StateT s m (Either a b)

getBytes :: Int -> StateT s m ByteString

remaining :: StateT s m (Remaining (StateT s m))

isEmpty :: StateT s m Bool

getWord8 :: StateT s m Word8

getByteString :: Int -> StateT s m ByteString

getLazyByteString :: Int64 -> StateT s m ByteString

getWord16be :: StateT s m Word16

getWord16le :: StateT s m Word16

getWord16host :: StateT s m Word16

getWord32be :: StateT s m Word32

getWord32le :: StateT s m Word32

getWord32host :: StateT s m Word32

getWord64be :: StateT s m Word64

getWord64le :: StateT s m Word64

getWord64host :: StateT s m Word64

getWordhost :: StateT s m Word

(MonadGet m, Monoid w) => MonadGet (WriterT w m)

Defined in Data.Bytes.Get

Associated Types

type Remaining (WriterT w m) :: *

type Bytes (WriterT w m) :: *

Methods

skip :: Int -> WriterT w m ()

ensure :: Int -> WriterT w m ByteString

lookAhead :: WriterT w m a -> WriterT w m a

lookAheadM :: WriterT w m (Maybe a) -> WriterT w m (Maybe a)

lookAheadE :: WriterT w m (Either a b) -> WriterT w m (Either a b)

getBytes :: Int -> WriterT w m ByteString

remaining :: WriterT w m (Remaining (WriterT w m))

isEmpty :: WriterT w m Bool

getWord8 :: WriterT w m Word8

getByteString :: Int -> WriterT w m ByteString

getLazyByteString :: Int64 -> WriterT w m ByteString

getWord16be :: WriterT w m Word16

getWord16le :: WriterT w m Word16

getWord16host :: WriterT w m Word16

getWord32be :: WriterT w m Word32

getWord32le :: WriterT w m Word32

getWord32host :: WriterT w m Word32

getWord64be :: WriterT w m Word64

getWord64le :: WriterT w m Word64

getWord64host :: WriterT w m Word64

getWordhost :: WriterT w m Word

(MonadGet m, Monoid w) => MonadGet (WriterT w m)

Defined in Data.Bytes.Get

Associated Types

type Remaining (WriterT w m) :: *

type Bytes (WriterT w m) :: *

Methods

skip :: Int -> WriterT w m ()

ensure :: Int -> WriterT w m ByteString

lookAhead :: WriterT w m a -> WriterT w m a

lookAheadM :: WriterT w m (Maybe a) -> WriterT w m (Maybe a)

lookAheadE :: WriterT w m (Either a b) -> WriterT w m (Either a b)

getBytes :: Int -> WriterT w m ByteString

remaining :: WriterT w m (Remaining (WriterT w m))

isEmpty :: WriterT w m Bool

getWord8 :: WriterT w m Word8

getByteString :: Int -> WriterT w m ByteString

getLazyByteString :: Int64 -> WriterT w m ByteString

getWord16be :: WriterT w m Word16

getWord16le :: WriterT w m Word16

getWord16host :: WriterT w m Word16

getWord32be :: WriterT w m Word32

getWord32le :: WriterT w m Word32

getWord32host :: WriterT w m Word32

getWord64be :: WriterT w m Word64

getWord64le :: WriterT w m Word64

getWord64host :: WriterT w m Word64

getWordhost :: WriterT w m Word

MonadGet m => MonadGet (ReaderT e m)

Defined in Data.Bytes.Get

Associated Types

type Remaining (ReaderT e m) :: *

type Bytes (ReaderT e m) :: *

Methods

skip :: Int -> ReaderT e m ()

ensure :: Int -> ReaderT e m ByteString

lookAhead :: ReaderT e m a -> ReaderT e m a

lookAheadM :: ReaderT e m (Maybe a) -> ReaderT e m (Maybe a)

lookAheadE :: ReaderT e m (Either a b) -> ReaderT e m (Either a b)

getBytes :: Int -> ReaderT e m ByteString

remaining :: ReaderT e m (Remaining (ReaderT e m))

isEmpty :: ReaderT e m Bool

getWord8 :: ReaderT e m Word8

getByteString :: Int -> ReaderT e m ByteString

getLazyByteString :: Int64 -> ReaderT e m ByteString

getWord16be :: ReaderT e m Word16

getWord16le :: ReaderT e m Word16

getWord16host :: ReaderT e m Word16

getWord32be :: ReaderT e m Word32

getWord32le :: ReaderT e m Word32

getWord32host :: ReaderT e m Word32

getWord64be :: ReaderT e m Word64

getWord64le :: ReaderT e m Word64

getWord64host :: ReaderT e m Word64

getWordhost :: ReaderT e m Word

(MonadGet m, Monoid w) => MonadGet (RWST r w s m)

Defined in Data.Bytes.Get

Associated Types

type Remaining (RWST r w s m) :: *

type Bytes (RWST r w s m) :: *

Methods

skip :: Int -> RWST r w s m ()

ensure :: Int -> RWST r w s m ByteString

lookAhead :: RWST r w s m a -> RWST r w s m a

lookAheadM :: RWST r w s m (Maybe a) -> RWST r w s m (Maybe a)

lookAheadE :: RWST r w s m (Either a b) -> RWST r w s m (Either a b)

getBytes :: Int -> RWST r w s m ByteString

remaining :: RWST r w s m (Remaining (RWST r w s m))

isEmpty :: RWST r w s m Bool

getWord8 :: RWST r w s m Word8

getByteString :: Int -> RWST r w s m ByteString

getLazyByteString :: Int64 -> RWST r w s m ByteString

getWord16be :: RWST r w s m Word16

getWord16le :: RWST r w s m Word16

getWord16host :: RWST r w s m Word16

getWord32be :: RWST r w s m Word32

getWord32le :: RWST r w s m Word32

getWord32host :: RWST r w s m Word32

getWord64be :: RWST r w s m Word64

getWord64le :: RWST r w s m Word64

getWord64host :: RWST r w s m Word64

getWordhost :: RWST r w s m Word

(MonadGet m, Monoid w) => MonadGet (RWST r w s m)

Defined in Data.Bytes.Get

Associated Types

type Remaining (RWST r w s m) :: *

type Bytes (RWST r w s m) :: *

Methods

skip :: Int -> RWST r w s m ()

ensure :: Int -> RWST r w s m ByteString

lookAhead :: RWST r w s m a -> RWST r w s m a

lookAheadM :: RWST r w s m (Maybe a) -> RWST r w s m (Maybe a)

lookAheadE :: RWST r w s m (Either a b) -> RWST r w s m (Either a b)

getBytes :: Int -> RWST r w s m ByteString

remaining :: RWST r w s m (Remaining (RWST r w s m))

isEmpty :: RWST r w s m Bool

getWord8 :: RWST r w s m Word8

getByteString :: Int -> RWST r w s m ByteString

getLazyByteString :: Int64 -> RWST r w s m ByteString

getWord16be :: RWST r w s m Word16

getWord16le :: RWST r w s m Word16

getWord16host :: RWST r w s m Word16

getWord32be :: RWST r w s m Word32

getWord32le :: RWST r w s m Word32

getWord32host :: RWST r w s m Word32

getWord64be :: RWST r w s m Word64

getWord64le :: RWST r w s m Word64

getWord64host :: RWST r w s m Word64

getWordhost :: RWST r w s m Word

runGetL :: Get a -> ByteString -> a

Get something from a lazy ByteString using runGet.

runGetS :: Get a -> ByteString -> Either String a

Get something from a strict ByteString using runGet.