Haskus.Format.Binary.Bits.Get

Bit getter

Documentation

data BitGetState

BitGet state

Constructors

BitGetState

Fields

• bitGetStateInput :: !Buffer

  Input

• bitGetStateBitOffset :: !Word

  Bit offset (0-7)

• bitGetStateBitOrder :: !BitOrder

  Bit order

Instances

Show BitGetState

Defined in Haskus.Format.Binary.Bits.Get

Methods

showsPrec :: Int -> BitGetState -> ShowS

show :: BitGetState -> String

showList :: [BitGetState] -> ShowS

newBitGetState :: BitOrder -> Buffer -> BitGetState

Create a new BitGetState

isEmpty :: BitGetState -> Bool

Indicate that the source is empty

skipBits :: Word -> BitGetState -> BitGetState

Skip the given number of bits from the input

skipBitsToAlignOnWord8 :: BitGetState -> BitGetState

Skip the required number of bits to be aligned on 8-bits

getBits :: (Integral a, Bits a) => Word -> BitGetState -> a

Read the given number of bits and put the result in a word

getBitsChecked :: (Integral a, Bits a, ReversableBits a) => Word -> Word -> BitGetState -> a

Perform some checks before calling getBits

Check that the number of bits to read is not greater than the first parameter

getBitsBuffer :: Word -> BitGetState -> Buffer

Read the given number of Word8 and return them in a Buffer

Examples: BB: xxxABCDE FGHIJKLM NOPxxxxx -> ABCDEFGH IJKLMNOP LL: LMNOPxxx DEFGHIJK xxxxxABC -> ABCDEFGH IJKLMNOP BL: xxxPONML KJIHGFED CBAxxxxx -> ABCDEFGH IJKLMNOP LB: EDCBAxxx MLKJIHGF xxxxxPON -> ABCDEFGH IJKLMNOP

Monadic

type BitGet a = BitGetT Identity a

BitGet monad

type BitGetT m a = StateT BitGetState m a

BitGet monad transformer

runBitGet :: BitOrder -> BitGet a -> Buffer -> a

Evaluate a BitGet monad

runBitGetT :: Monad m => BitOrder -> BitGetT m a -> Buffer -> m a

Evaluate a BitGet monad

runBitGetPartialT :: BitOrder -> BitGetT m a -> Buffer -> m (a, BitGetState)

Evaluate a BitGet monad, return the remaining state

runBitGetPartial :: BitOrder -> BitGet a -> Buffer -> (a, BitGetState)

Evaluate a BitGet monad, return the remaining state

resumeBitGetPartialT :: BitGetT m a -> BitGetState -> m (a, BitGetState)

Resume a BitGet evaluation

resumeBitGetPartial :: BitGet a -> BitGetState -> (a, BitGetState)

Resume a BitGet evaluation

isEmptyM :: Monad m => BitGetT m Bool

Indicate if all bits have been read

skipBitsM :: Monad m => Word -> BitGetT m ()

Skip the given number of bits from the input (monadic version)

skipBitsToAlignOnWord8M :: Monad m => BitGetT m ()

Skip the required number of bits to be aligned on 8-bits (monadic version)

getBitsM :: (Integral a, Bits a, Monad m) => Word -> BitGetT m a

Read the given number of bits and put the result in a word

getBitsCheckedM :: (Integral a, Bits a, ReversableBits a, Monad m) => Word -> Word -> BitGetT m a

Perform some checks before calling getBitsM

getBitBoolM :: Monad m => BitGetT m Bool

Get a bit and convert it into a Bool

getBitsBSM :: Monad m => Word -> BitGetT m Buffer

Get the given number of Word8

changeBitGetOrder :: Monad m => BitOrder -> BitGetT 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 read the same bits more than once.

withBitGetOrder :: Monad m => BitOrder -> BitGetT m a -> BitGetT m a

Change the bit ordering for the wrapped BitGet

Be careful, this function uses changeBitGetOrder internally.