Foreign.Storable.Generic.Internal

Documentation

class GStorable' f where

Minimal complete definition

gpeekByteOff', gpokeByteOff', gnumberOf', glistSizeOf', glistAlignment'

Methods

gpeekByteOff' :: [Int] -> Int -> Ptr b -> Int -> IO (f a)

Read the element at a given offset. Additional information about the offests of the subfields are needed.

gpokeByteOff' :: [Int] -> Int -> Ptr b -> Int -> f a -> IO ()

gnumberOf' :: f a -> Int

Calculates the number of type's/struct's fields.

glistSizeOf' :: f a -> [Size]

Calculates the sizes of type's/struct's fields.

glistAlignment' :: f a -> [Alignment]

Calculates the alignments of type's/struct's fields.

Instances

GStorable a => GStorable' (K1 i a)

Methods

gpeekByteOff' :: [Int] -> Int -> Ptr b -> Int -> IO (K1 i a a)

gpokeByteOff' :: [Int] -> Int -> Ptr b -> Int -> K1 i a a -> IO ()

gnumberOf' :: K1 i a a -> Int

glistSizeOf' :: K1 i a a -> [Size]

glistAlignment' :: K1 i a a -> [Alignment]

(GStorable' f, GStorable' g) => GStorable' ((:*:) f g)

Methods

gpeekByteOff' :: [Int] -> Int -> Ptr b -> Int -> IO ((f :*: g) a)

gpokeByteOff' :: [Int] -> Int -> Ptr b -> Int -> (f :*: g) a -> IO ()

gnumberOf' :: (f :*: g) a -> Int

glistSizeOf' :: (f :*: g) a -> [Size]

glistAlignment' :: (f :*: g) a -> [Alignment]

GStorable' f => GStorable' (M1 i t f)

Methods

gpeekByteOff' :: [Int] -> Int -> Ptr b -> Int -> IO (M1 i t f a)

gpokeByteOff' :: [Int] -> Int -> Ptr b -> Int -> M1 i t f a -> IO ()

gnumberOf' :: M1 i t f a -> Int

glistSizeOf' :: M1 i t f a -> [Size]

glistAlignment' :: M1 i t f a -> [Alignment]

class GStorable a where

The class uses the default Generic based implementations to provide Storable instances for types made from primitive types. Does not work on Algebraic Data Types with more than one constructor.

Methods

gsizeOf :: a -> Int

Calculate the size of the type.

gsizeOf :: (Generic a, GStorable' (Rep a)) => a -> Int

Calculate the size of the type.

galignment :: a -> Int

Calculate the alignment of the type.

galignment :: (Generic a, GStorable' (Rep a)) => a -> Int

Calculate the alignment of the type.

gpeekByteOff :: Ptr b -> Int -> IO a

Read the variable from a given pointer.

gpeekByteOff :: (Generic a, GStorable' (Rep a)) => Ptr b -> Int -> IO a

Read the variable from a given pointer.

gpokeByteOff :: Ptr b -> Int -> a -> IO ()

Write the variable to a pointer.

gpokeByteOff :: (Generic a, GStorable' (Rep a)) => Ptr b -> Int -> a -> IO ()

Write the variable to a pointer.

internalSizeOf

Arguments

:: GStorable' f

=> f p

Generic representation

-> Int

Resulting size

Calculates the size of generic data-type.

internalAlignment

Arguments

:: GStorable' f

=> f p

Generic representation

-> Alignment

Resulting alignment

Calculates the alignment of generic data-type.

internalPeekByteOff

Arguments

:: GStorable' f

=> Ptr b

Pointer to peek

-> Offset

Offset

-> IO (f p)

Resulting generic representation

View the variable under a pointer, with offset.

internalPokeByteOff

Arguments

:: GStorable' f

=> Ptr b

Pointer to write to

-> Offset

Offset

-> f p

Written generic representation

-> IO ()

Write the variable under the pointer, with offset.

internalOffsets :: forall f p. GStorable' f => f p -> [Offset]

Obtain the list of offsets