|
| Data.Binary.BitPut | | Stability | experimental | | Maintainer | Dominic Steinitz <dominic.steinitz@blueyonder.co.uk> |
|
|
|
| Description |
This is the writer dual to BitGet. It allows one to append bits in a monad
and get a strict ByteString as a result. Bits are appended from the MSB of
the first byte towards the LSB of the last byte.
This is best suited to small bit-fields because it accumulates bytes using
snoc, so large results will cause a lot of copying. It would be possible
to switch to using something similar to the Builder monad if need arises.
However, since most protocols only have small bit fields, this should
suffice for many cases.
|
|
| Synopsis |
|
|
|
| Documentation |
|
|
|
|
|
|
| Append a single bit
|
|
|
| Append the bottom n bits of the given bits value. In the case that more
bits are requested than the value provides, this acts as if the value
has as unlimited number of leading 0 bits.
|
|
|
| Append a value. Note that this function is undefined for instances of Bits
which have no fixed bitsize (like Integer)
|
|
|
| Append a ByteString
|
|
|
| Append a left aligned ByteString where ByteString has a partial byte
with the given number of valid bits, from the MSB downwards. The number
of such bits must be 0..7. (A normal ByteString, which all bytes full
would use 0)
|
|
| Produced by Haddock version 2.4.2 |
