Haskus.Format.Binary.Layout

Memory layout

Describe a memory region

Documentation

type family LayoutPathType l p :: *

Type obtained when following path p

Instances

type LayoutPathType l (LayoutPath ([] *))

type LayoutPathType l (LayoutPath ([] *)) = l

type family LayoutPathOffset l p :: Nat

Offset obtained when following path p

Instances

type LayoutPathOffset e (LayoutPath ([] *))

type LayoutPathOffset e (LayoutPath ([] *)) = 0

type LayoutRoot = LayoutPath '[]

data LayoutPath path

Path in a layout

Constructors

LayoutPath

Instances

type LayoutPathOffset e (LayoutPath ([] *))

type LayoutPathOffset e (LayoutPath ([] *)) = 0

type LayoutPathType l (LayoutPath ([] *))

type LayoutPathType l (LayoutPath ([] *)) = l

data LayoutIndex n

Index in a layout path

Constructors

LayoutIndex

data LayoutSymbol s

Symbol in a layout path

Constructors

LayoutSymbol

layoutIndex :: forall n. LayoutPath '[LayoutIndex n]

Index in the layout path

layoutSymbol :: forall s. LayoutPath '[LayoutSymbol s]

Symbol in the layout path

type family p :-> (s :: Symbol) where ...

Equations

(LayoutPath xs) :-> s = LayoutPath (Snoc xs (LayoutSymbol s))

type family p :#> (n :: Nat) where ...

Equations

(LayoutPath xs) :#> n = LayoutPath (Snoc xs (LayoutIndex n))