Safe Haskell	None
Language	Haskell2010

Haskus.Binary.Bits.Put

Contents

Monadic

Description

Bit putter

Synopsis

data BitPutState = BitPutState {
- bitPutStateBuilder :: !BufferBuilder
- bitPutStateCurrent :: !Word8
- bitPutStateOffset :: !Word
- bitPutStateBitOrder :: !BitOrder
}
newBitPutState :: BitOrder -> BitPutState
putBits :: (Integral a, Bits a, ReversableBits a) => Word -> a -> BitPutState -> BitPutState
putBitsBuffer :: Buffer -> BitPutState -> BitPutState
getBitPutBuffer :: BitPutState -> Buffer
getBitPutBufferList :: BitPutState -> BufferList
type BitPut a = BitPutT Identity a
type BitPutT m a = StateT BitPutState m a
runBitPut :: BitOrder -> BitPut a -> Buffer
runBitPutT :: Monad m => BitOrder -> BitPutT m a -> m Buffer
putBitsM :: (Monad m, Integral a, Bits a, ReversableBits a) => Word -> a -> BitPutT m ()
putBitBoolM :: Monad m => Bool -> BitPutT m ()
putBitsBufferM :: Monad m => Buffer -> BitPutT m ()
changeBitPutOrder :: Monad m => BitOrder -> BitPutT m ()
withBitPutOrder :: Monad m => BitOrder -> BitPutT m a -> BitPutT m a

Documentation

data BitPutState Source #

BitPut state

Constructors

BitPutState
Fields bitPutStateBuilder :: !BufferBuilder Builder bitPutStateCurrent :: !Word8 Current byte bitPutStateOffset :: !Word Current offset bitPutStateBitOrder :: !BitOrder Bit order

newBitPutState :: BitOrder -> BitPutState Source #

Create a new BitPut state

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

Put bits

putBitsBuffer :: Buffer -> BitPutState -> BitPutState Source #

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 Source #

Get a Buffer

getBitPutBufferList :: BitPutState -> BufferList Source #

Get a buffer list

Monadic

type BitPut a = BitPutT Identity a Source #

BitPut monad

type BitPutT m a = StateT BitPutState m a Source #

BitPut monad transformer

runBitPut :: BitOrder -> BitPut a -> Buffer Source #

Evaluate a BitPut monad

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

Evaluate a BitPut monad

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

Put bits (monadic)

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

Put a single bit (monadic)

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

Put a Buffer (monadic)

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

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 Source #

Change the bit ordering for the wrapped BitPut

Be careful, this function uses changeBitPutOrder internally.