Haskus.Format.Binary.Bits.Put

Bit putter

Documentation

data BitPutState

BitPut state

Constructors

BitPutState

Fields

• bitPutStateBuilder :: !BufferBuilder

  Builder

• bitPutStateCurrent :: !Word8

  Current byte

• bitPutStateOffset :: !Word

  Current offset

• bitPutStateBitOrder :: !BitOrder

  Bit order

newBitPutState :: BitOrder -> BitPutState

Create a new BitPut state

putBits :: (Integral a, Bits a, ReversableBits a) => Word -> a -> BitPutState -> BitPutState

Put bits

putBitsBuffer :: Buffer -> BitPutState -> BitPutState

Put a Buffer

Examples: 3 bits are already written in the current byte BB: ABCDEFGH IJKLMNOP -> xxxABCDE FGHIJKLM NOPxxxxx LL: ABCDEFGH IJKLMNOP -> LMNOPxxx DEFGHIJK xxxxxABC BL: ABCDEFGH IJKLMNOP -> xxxPONML KJIHGFED CBAxxxxx LB: ABCDEFGH IJKLMNOP -> EDCBAxxx MLKJIHGF xxxxxPON

getBitPutBuffer :: BitPutState -> Buffer

Get a Buffer

getBitPutBufferList :: BitPutState -> BufferList

Get a buffer list

Monadic

type BitPut a = BitPutT Identity a

BitPut monad

type BitPutT m a = StateT BitPutState m a

BitPut monad transformer

runBitPut :: BitOrder -> BitPut a -> Buffer

Evaluate a BitPut monad

runBitPutT :: Monad m => BitOrder -> BitPutT m a -> m Buffer

Evaluate a BitPut monad

putBitsM :: (Monad m, Integral a, Bits a, ReversableBits a) => Word -> a -> BitPutT m ()

Put bits (monadic)

putBitBoolM :: Monad m => Bool -> BitPutT m ()

Put a single bit (monadic)

putBitsBufferM :: Monad m => Buffer -> BitPutT m ()

Put a Buffer (monadic)

changeBitPutOrder :: Monad m => BitOrder -> BitPutT m ()

Change the current bit ordering

Be careful to change the outer bit ordering (B* to L* or the inverse) only on bytes boundaries! Otherwise, you will write the same bits more than once.

withBitPutOrder :: Monad m => BitOrder -> BitPutT m a -> BitPutT m a

Change the bit ordering for the wrapped BitPut

Be careful, this function uses changeBitPutOrder internally.