Haskus.Format.Binary.Record

Record (similar to C struct)

Documentation

data Record fields

Record

Instances

(HFoldr' Extract (Record fs, HList ([] *)) fs (Record fs, HList fs), Show (HList fs)) => Show (Record fs)

Methods

showsPrec :: Int -> Record fs -> ShowS

show :: Record fs -> String

showList :: [Record fs] -> ShowS

((~) Nat s (FullRecordSize fs), KnownNat s) => StaticStorable (Record fs)

Associated Types

type SizeOf (Record fs) :: Nat

type Alignment (Record fs) :: Nat

Methods

staticPeekIO :: Ptr (Record fs) -> IO (Record fs)

staticPokeIO :: Ptr (Record fs) -> Record fs -> IO ()

type SizeOf (Record fs)

type SizeOf (Record fs)

type Alignment (Record fs)

type Alignment (Record fs)

data Field name typ

Field

type family RecordSize (fs :: [*]) (sz :: Nat) where ...

Get record size without the ending padding bytes

Equations

RecordSize '[] sz = sz

RecordSize (Field name typ ': fs) sz = RecordSize fs ((sz + Padding sz typ) + SizeOf typ)

type family Modulo (a :: Nat) (b :: Nat) :: Nat where ...

Modulo

Equations

Modulo a b = Modulo' ((<=?) a b) a b

data Path fs

recordSize :: forall fs. KnownNat (FullRecordSize fs) => Record fs -> Word

Get record size

recordAlignment :: forall fs. KnownNat (RecordAlignment fs 1) => Record fs -> Word

Get record alignment

recordField :: forall name a fs. (KnownNat (FieldOffset name fs 0), a ~ FieldType name fs, StaticStorable a) => Record fs -> a

Get a field

recordFieldOffset :: forall name fs. KnownNat (FieldOffset name fs 0) => Record fs -> Int

Get a field offset

recordFieldPath :: forall path a fs o. (o ~ FieldPathOffset fs path 0, a ~ FieldPathType fs path, KnownNat o, StaticStorable a) => Path path -> Record fs -> a

Get a field from its path

recordFieldPathOffset :: forall path fs o. (o ~ FieldPathOffset fs path 0, KnownNat o) => Path path -> Record fs -> Int

Get a field offset from its path

recordToList :: forall fs. HFoldr' Extract (Record fs, HList '[]) fs (Record fs, HList fs) => Record fs -> HList fs

Convert a record into a HList