Builder

A Builder type for ByteArray. Appending these builders can be cheaper than when appending ByteArray values, since you only perform one buffer allocation.

Builder type

data Builder

A Builder for ByteArrays that has O(1) append. To create a ByteArray, use build. This will only do one allocation.

Instances

Semigroup Builder

Defined in Builder

Methods

(<>) :: Builder -> Builder -> Builder

sconcat :: NonEmpty Builder -> Builder

stimes :: Integral b => b -> Builder -> Builder

Monoid Builder

Defined in Builder

Methods

mempty :: Builder

mappend :: Builder -> Builder -> Builder

mconcat :: [Builder] -> Builder

Consumption

build :: Builder -> ByteArray

Convert a Builder into a ByteArray.

Construction

buildUnaligned :: (Prim a, PrimUnaligned a) => a -> Builder

A Builder for any Prim and PrimUnaligned value.

buildWord8 :: Word8 -> Builder

A Builder for Word8.

buildWord16 :: Word16 -> Builder

A Builder for Word16.

buildWord32 :: Word32 -> Builder

A Builder for Word32.

buildWord64 :: Word64 -> Builder

A Builder for Word64.

buildWord :: Word -> Builder

A Builder for Word.

buildInt8 :: Int8 -> Builder

A Builder for Int8.

buildInt16 :: Int16 -> Builder

A Builder for Int16.

buildInt32 :: Int32 -> Builder

A Builder for Int32.

buildInt64 :: Int64 -> Builder

A Builder for Int64.

buildInt :: Int -> Builder

A Builder for Int.

buildFloat :: Float -> Builder

A Builder for Float.

buildDouble :: Double -> Builder

A Builder for Double.

buildChar :: Char -> Builder

A Builder for Char.

buildPtr :: Ptr a -> Builder

A Builder for Ptr a.

buildByteArray

Arguments

:: ByteArray

source array

-> Int

offset into source array

-> Int

number of bytes to copy

-> Builder

A Builder for a ByteArray slice.

buildFixed :: (FixedOrdering b, Bytes a, Prim a, PrimUnaligned a) => Fixed b a -> Builder

A Builder for Fixed b a This provides better control over endianness when writing.