Bytezap.Write.Internal

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?

Constructors

Write

Fields

• writeLength :: Int

  Length of the write in bytes.

  This is not statically asserted. Any time you construct a Write, you must promise this.

  For Write ExactLength s, this is an exact measurement. For Write MaxLength s, this is a maximum.

• writeOp :: Poke s

  The Poke buffer write operation.

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.

writeMax :: Write 'ExactLength s -> Write 'MaxLength s

Turn a Write ExactLength into a Write MaxLength.

writeMaxExact :: Write 'MaxLength s -> Write 'ExactLength s -> Write 'MaxLength s

Sequence a Write MaxLength and a Write ExactLength left-to-right.

writeExactMax :: Write 'ExactLength s -> Write 'MaxLength s -> Write 'MaxLength s

Sequence a Write MaxLength and a Write ExactLength left-to-right.

writeCombine :: forall (ltl :: LengthType) s (ltr :: LengthType) (lt :: LengthType). Write ltl s -> Write ltr s -> Write lt s

Sequence two Writes left-to-right.

Unsafe, as it ignores LengthTypes.

TODO strictness? INLINE[1]? INLINE[0]?