Bytezap.Write

Documentation

data Write (lt :: LengthType) s

A Poke buffer write operation with the associated length to be written.

The length may be either exact or a maximum.

TODO strictness?

Instances

Monoid (Write lt s)

The empty Write is the empty Poke, which writes zero bytes.

Defined in Bytezap.Write.Internal

Methods

mempty :: Write lt s

mappend :: Write lt s -> Write lt s -> Write lt s

mconcat :: [Write lt s] -> Write lt s

Semigroup (Write lt s)

Sequence the writes, sum the lengths.

Defined in Bytezap.Write.Internal

Methods

(<>) :: Write lt s -> Write lt s -> Write lt s

sconcat :: NonEmpty (Write lt s) -> Write lt s

stimes :: Integral b => b -> Write lt s -> Write lt s

data LengthType

What a buffer write length field means.

Constructors

ExactLength

Exact length to be written.

MaxLength

Maximum length to be written.

runWriteBS :: Write 'ExactLength RealWorld -> ByteString

runWriteBSUptoN :: Write 'MaxLength RealWorld -> ByteString

prim :: Prim' a => a -> Write 'ExactLength s

byteString :: ByteString -> Write 'ExactLength RealWorld

byteArray# :: ByteArray# -> Int# -> Int# -> Write 'ExactLength s

replicateByte :: Int -> Word8 -> Write 'ExactLength RealWorld

essentially memset