bytezap-1.6.0: Bytestring builder with zero intermediate allocation
Safe HaskellNone
LanguageGHC2021

Bytezap.Struct.TypeLits.Bytes

Description

Efficient type-level bytestring serialization via chunking.

I did a quick Core check and found that GHC seems to successfully generate minimal code for this e.g. for an 8-byte magic, GHC will do one writeWord64OffAddr# of a constant. Great!

The only way I can think of to make this faster is to somehow obtain an Addr# with a known length. With that, we could memcpy. But that would be slower for small magics, and maybe others. And I doubt we can conjure up an Addr# at compile time. So I'm fairly confident that this is the best you're gonna get.

Synopsis

Chunking design

[Natural]s have a convenient syntax, and we can use them as a type-level bytestring by asserting that each Natural is <=255 when reifying. This module provides type classes which give you a serializer for a given [Natural].

We maximize efficiency by grouping bytes into machine words. We have to be pretty verbose to achieve this. Each type class attempts to group bytes into its machine word type, and if it can't (i.e. not enough bytes remain), it hands off to the next type class which handles the next smaller machine word.

TODO rewrite :)

class ReifyBytesW64 (bs :: [Natural]) where Source #

Serialize a type-level bytestring, largest grouping Word64.

Instances

Instances details
ReifyBytesW32 bs => ReifyBytesW64 bs Source #

Try to group Word32s next.

Instance details

Defined in Bytezap.Struct.TypeLits.Bytes

(ReifyW8 b0, ReifyW8 b1, ReifyW8 b2, ReifyW8 b3, ReifyW8 b4, ReifyW8 b5, ReifyW8 b6, ReifyW8 b7, ReifyBytesW64 bs) => ReifyBytesW64 (b0 ': (b1 ': (b2 ': (b3 ': (b4 ': (b5 ': (b6 ': (b7 ': bs)))))))) Source #

Enough bytes to make a Word64.

Instance details

Defined in Bytezap.Struct.TypeLits.Bytes

class ReifyBytesW32 (bs :: [Natural]) where Source #

Serialize a type-level bytestring, largest grouping Word32.

Instances

Instances details
ReifyBytesW16 bs => ReifyBytesW32 bs Source #

Try to group Word16s next.

Instance details

Defined in Bytezap.Struct.TypeLits.Bytes

(ReifyW8 b0, ReifyW8 b1, ReifyW8 b2, ReifyW8 b3, ReifyBytesW32 bs) => ReifyBytesW32 (b0 ': (b1 ': (b2 ': (b3 ': bs)))) Source #

Enough bytes to make a Word32.

Instance details

Defined in Bytezap.Struct.TypeLits.Bytes

class ReifyBytesW16 (bs :: [Natural]) where Source #

Serialize a type-level bytestring, largest grouping Word16.

Instances

Instances details
ReifyBytesW8 bs => ReifyBytesW16 bs Source #

Reify byte-by-byte next.

Instance details

Defined in Bytezap.Struct.TypeLits.Bytes

(ReifyW8 b0, ReifyW8 b1, ReifyBytesW16 bs) => ReifyBytesW16 (b0 ': (b1 ': bs)) Source #

Enough bytes to make a Word16.

Instance details

Defined in Bytezap.Struct.TypeLits.Bytes

class ReifyBytesW8 (bs :: [Natural]) where Source #

Serialize a type-level bytestring, byte-by-byte.

Instances

Instances details
ReifyBytesW8 ('[] :: [Natural]) Source #

End of the line.

Instance details

Defined in Bytezap.Struct.TypeLits.Bytes

(ReifyW8 b0, ReifyBytesW8 bs) => ReifyBytesW8 (b0 ': bs) Source #

Reify the next byte.

Instance details

Defined in Bytezap.Struct.TypeLits.Bytes