| Copyright | (c) 2013 Leon P Smith |
|---|---|
| License | BSD3 |
| Maintainer | https://github.com/blaze-builder |
| Stability | stable |
| Safe Haskell | None |
| Language | Haskell98 |
Blaze.ByteString.Builder.Word
Description
Writes and Builders for serializing words.
Note that for serializing a three tuple (x,y,z) of bytes (or other word
values) you should use the expression
fromWrite $ writeWord8 x `mappend` writeWord8 y `mappend` writeWord z
instead of
fromWord8 x `mappend` fromWord8 y `mappend` fromWord z
The first expression will result in a single atomic write of three bytes, while the second expression will check for each byte, if there is free space left in the output buffer. Coalescing these checks can improve performance quite a bit, as long as you use it sensibly.
Synopsis
- writeWord8 :: Word8 -> Write
- writeWord16be :: Word16 -> Write
- writeWord32be :: Word32 -> Write
- writeWord64be :: Word64 -> Write
- writeWord16le :: Word16 -> Write
- writeWord32le :: Word32 -> Write
- writeWord64le :: Word64 -> Write
- writeWordhost :: Word -> Write
- writeWord16host :: Word16 -> Write
- writeWord32host :: Word32 -> Write
- writeWord64host :: Word64 -> Write
- fromWord8 :: Word8 -> Builder
- fromWord8s :: [Word8] -> Builder
- fromWord16be :: Word16 -> Builder
- fromWord32be :: Word32 -> Builder
- fromWord64be :: Word64 -> Builder
- fromWord32sbe :: [Word32] -> Builder
- fromWord16sbe :: [Word16] -> Builder
- fromWord64sbe :: [Word64] -> Builder
- fromWord16le :: Word16 -> Builder
- fromWord32le :: Word32 -> Builder
- fromWord64le :: Word64 -> Builder
- fromWord16sle :: [Word16] -> Builder
- fromWord32sle :: [Word32] -> Builder
- fromWord64sle :: [Word64] -> Builder
- fromWordhost :: Word -> Builder
- fromWord16host :: Word16 -> Builder
- fromWord32host :: Word32 -> Builder
- fromWord64host :: Word64 -> Builder
- fromWordshost :: [Word] -> Builder
- fromWord16shost :: [Word16] -> Builder
- fromWord32shost :: [Word32] -> Builder
- fromWord64shost :: [Word64] -> Builder
Writing words to a buffer
writeWord8 :: Word8 -> Write Source #
Write a single byte.
Big-endian writes
Little-endian writes
Host-endian writes
writeWordhost :: Word -> Write Source #
Creating builders from words
We provide serialization functions both for singleton words as well as
for lists of words. Using these list serialization functions is much faster
than using mconcat . map fromWord<n>, as the list serialization
functions use a tighter inner loop.
fromWord8s :: [Word8] -> Builder Source #
Serialize a list of bytes.
Big-endian serialization
Little-endian serialization
Host-endian serialization
fromWordhost :: Word -> Builder Source #
Serialize a single native machine Word. The Word is serialized in host
order, host endian form, for the machine you're on. On a 64 bit machine the
Word is an 8 byte value, on a 32 bit machine, 4 bytes. Values written this
way are not portable to different endian or word sized machines, without
conversion.
fromWord16host :: Word16 -> Builder Source #
Write a Word16 in native host order and host endianness.
fromWord32host :: Word32 -> Builder Source #
Write a Word32 in native host order and host endianness.
fromWord64host :: Word64 -> Builder Source #
Write a Word64 in native host order and host endianness.
fromWordshost :: [Word] -> Builder Source #
Serialize a list of Words.
See fromWordhost for usage considerations.
fromWord16shost :: [Word16] -> Builder Source #
Write a list of Word16s in native host order and host endianness.