Data.Bits.Coding

Documentation

newtype Coding m a

Constructors

Coding

Fields

• runCoding :: forall r. (a -> Int -> Word8 -> m r) -> Int -> Word8 -> m r

Instances

MonadTrans Coding

Methods

lift :: Monad m => m a -> Coding m a

MonadReader e m => MonadReader e (Coding m)

Methods

ask :: Coding m e

local :: (e -> e) -> Coding m a -> Coding m a

reader :: (e -> a) -> Coding m a

MonadState s m => MonadState s (Coding m)

Methods

get :: Coding m s

put :: s -> Coding m ()

state :: (s -> (a, s)) -> Coding m a

Monad m => Monad (Coding m)

Methods

(>>=) :: Coding m a -> (a -> Coding m b) -> Coding m b

(>>) :: Coding m a -> Coding m b -> Coding m b

return :: a -> Coding m a

fail :: String -> Coding m a

Functor (Coding m)

Methods

fmap :: (a -> b) -> Coding m a -> Coding m b

(<$) :: a -> Coding m b -> Coding m a

Monad m => Applicative (Coding m)

Methods

pure :: a -> Coding m a

(<*>) :: Coding m (a -> b) -> Coding m a -> Coding m b

(*>) :: Coding m a -> Coding m b -> Coding m b

(<*) :: Coding m a -> Coding m b -> Coding m a

(Monad m, Alternative m) => Alternative (Coding m)

Methods

empty :: Coding m a

(<|>) :: Coding m a -> Coding m a -> Coding m a

some :: Coding m a -> Coding m [a]

many :: Coding m a -> Coding m [a]

MonadPlus m => MonadPlus (Coding m)

Methods

mzero :: Coding m a

mplus :: Coding m a -> Coding m a -> Coding m a

MonadGet m => MonadGet (Coding m)

Associated Types

type Remaining (Coding m :: * -> *) :: *

type Bytes (Coding m :: * -> *) :: *

Methods

skip :: Int -> Coding m ()

ensure :: Int -> Coding m ByteString

lookAhead :: Coding m a -> Coding m a

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

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

getBytes :: Int -> Coding m ByteString

remaining :: Coding m (Remaining (Coding m))

isEmpty :: Coding m Bool

getWord8 :: Coding m Word8

getByteString :: Int -> Coding m ByteString

getLazyByteString :: Int64 -> Coding m ByteString

getWord16be :: Coding m Word16

getWord16le :: Coding m Word16

getWord16host :: Coding m Word16

getWord32be :: Coding m Word32

getWord32le :: Coding m Word32

getWord32host :: Coding m Word32

getWord64be :: Coding m Word64

getWord64le :: Coding m Word64

getWord64host :: Coding m Word64

getWordhost :: Coding m Word

MonadPut m => MonadPut (Coding m)

Methods

putWord8 :: Word8 -> Coding m ()

putByteString :: ByteString -> Coding m ()

putLazyByteString :: ByteString -> Coding m ()

flush :: Coding m ()

putWord16le :: Word16 -> Coding m ()

putWord16be :: Word16 -> Coding m ()

putWord16host :: Word16 -> Coding m ()

putWord32le :: Word32 -> Coding m ()

putWord32be :: Word32 -> Coding m ()

putWord32host :: Word32 -> Coding m ()

putWord64le :: Word64 -> Coding m ()

putWord64be :: Word64 -> Coding m ()

putWord64host :: Word64 -> Coding m ()

putWordhost :: Word -> Coding m ()

type Bytes (Coding m)

type Bytes (Coding m) = Bytes m

type Remaining (Coding m)

type Remaining (Coding m) = Remaining m

Get

getAligned :: MonadGet m => m a -> Coding m a

Get something from byte-aligned storage, starting on the next byte and discarding any left over bits in the buffer.

NB: Using any operation from MonadGet other than checking remaining or isEmpty will implicitly perform this operation.

getBit :: MonadGet m => Coding m Bool

Get a single bit, consuming an entire byte if the bit buffer is empty

getBits :: (MonadGet m, Bits b) => Int -> Int -> b -> Coding m b

getBitsFrom :: (MonadGet m, Bits b) => Int -> b -> Coding m b

Put

putAligned :: MonadPut m => m a -> Coding m a

Emit any remaining contents from the bit buffer.

Any use of the combinators from MonadPut (including flush) will cause this to happen.

putUnaligned :: (MonadPut m, FiniteBits b) => b -> Coding m ()

Put all the bits without a flush

putBit :: MonadPut m => Bool -> Coding m ()

Put a single bit, emitting an entire byte if the bit buffer is full

putBits :: (MonadPut m, Bits b) => Int -> Int -> b -> Coding m ()

Put a (closed) range of bits

putBitsFrom :: (MonadPut m, Bits b) => Int -> b -> Coding m ()

putBitsFrom from b = putBits from 0 b