Foreign.Storable.Generic.Internal

Documentation

class GStorable' f where

Minimal complete definition

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

Methods

gpeekByteOff'

Arguments

:: [Int]

List of fields' offsets for the type/struct.

-> Int

The index. Used to obtain the correct offset

-> Ptr b

The pointer to the type/struct.

-> Int

Global offset.

-> IO (f a)

The result, wrapped in GHC.Generic metadata. | Write the element at a given offset. Additional information about the offests of the subfields are needed.

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

gpokeByteOff'

Arguments

:: [Int]

List of fields' offsets for the type/struct.

-> Int

The index. Used to obtain the correct offset.

-> Ptr b

The pointer to the type/struct.

-> Int

Global offset.

-> f a

The element to write, wrapped in GHC.Generic metadata.

-> IO ()

gnumberOf'

Arguments

:: f a

GHC.Generic information about a given type/struct.

-> Int

Size.

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

glistSizeOf'

Arguments

:: f a

GHC.Generic information about a given type/struct.

-> [Size]

List of sizes.

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

glistAlignment'

Arguments

:: f a

GHC.Generic information about a given type/struct.

-> [Alignment]

List of alignments.

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

Instances

GStorable' (U1 *)

Methods

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

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

gnumberOf' :: U1 * a -> Int

glistSizeOf' :: U1 * a -> [Size]

glistAlignment' :: U1 * a -> [Alignment]

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

Arguments

:: a

Element of a given type. Can be undefined.

-> Int

Size.

Calculate the size of the type.

gsizeOf

Arguments

:: (Generic a, GStorable' (Rep a))

=> a

Element of a given type. Can be undefined.

-> Int

Size.

Calculate the size of the type.

galignment

Arguments

:: a

Element of a given type. Can be undefined

-> Int

Alignment.

Calculate the alignment of the type.

galignment

Arguments

:: (Generic a, GStorable' (Rep a))

=> a

Element of a given type. Can be undefined

-> Int

Alignment.

Calculate the alignment of the type.

gpeekByteOff

Arguments

:: Ptr b

Pointer to the variable

-> Int

Offset

-> IO a

Returned variable.

Read the variable from a given pointer.

gpeekByteOff

Arguments

:: (Generic a, GStorable' (Rep a))

=> Ptr b

Pointer to the variable

-> Int

Offset

-> IO a

Returned variable.

Read the variable from a given pointer.

gpokeByteOff

Arguments

:: Ptr b

Pointer to the variable.

-> Int

Offset.

-> a

The variable

-> IO ()

Write the variable to a pointer.

gpokeByteOff

Arguments

:: (Generic a, GStorable' (Rep a))

=> Ptr b

Pointer to the variable.

-> Int

Offset.

-> a

The variable

-> 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