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

MonadReader e m => MonadReader e (Coding m)

MonadState s m => MonadState s (Coding m)

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

Monad m => Monad (Coding m)

Functor (Coding m)

MonadPlus m => MonadPlus (Coding m)

Monad m => Applicative (Coding m)

MonadGet m => MonadGet (Coding m)

MonadPut m => MonadPut (Coding m)

type Bytes (Coding m) = Bytes 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