Data.Layout.Language

A DSL for describing data laid out in a regular fashion with a combination of structures and arrays.

Combinators

repeat :: Reps -> Layout -> Layout

Repeat a layout n times.

offset :: Bytes -> Layout -> Layout

Skip n bytes before accessing the next part of the layout.

group :: Bytes -> Layout -> Layout

Wrap a layout with a group which is n bytes in size.

Value Formats

word8 :: Layout

8-bit word.

word16le :: Layout

16-bit word, little endian.

word32le :: Layout

32-bit word, little endian.

word64le :: Layout

64-bit word, little endian.

word16be :: Layout

16-bit word, big endian.

word32be :: Layout

32-bit word, big endian.

word64be :: Layout

64-bit word, big endian.

Optimizations

optimize :: Layout -> Layout

Remove redundancies from a layout.

Utility

size :: Layout -> Int

Calculates the total size of the layout.

byteOrder :: Layout -> ByteOrder

Gets the byte order of the values in the layout.

valueSize1 :: Layout -> Int

Calculates the size of a single value in the layout.

valueSizeN :: Layout -> Int

Calculates the total size of the values stored in the layout.

valueCount :: Layout -> Int

Counts the number of times a value is repeated in the layout.

chunk :: Int -> Layout -> [Layout]

Splits a repeated layout in to multiple layouts each with a maximum of n repetitions.