Foreign.Marshal.Pure.Internal

This abstract type class represents values natively known to have a GC-less implementation. Basically, these are sequences (represented as tuples) of base types.

Laws of Representable:

• toKnown must be total

• ofKnown may be partial, but must be total on the image of toKnown

• ofKnown . toKnown == id

This is an easier way to create an instance of Representable. It is a bit abusive to use a type class for this (after all, it almost never makes sense to use this as a constraint). But it works in practice.

To use, define an instance of MkRepresentable myType intermediateType then declare the following instance:

instance Representable myType where {type AsKnown = AsKnown intermediateType}

And the default instance mechanism will create the appropriate Representable instance.

Laws of MkRepresentable:

• toRepr must be total

• ofRepr may be partial, but must be total on the image of toRepr

• ofRepr . toRepr = id

Pools represent collections of values. A Pool can be consume-ed. This is a no-op: it does not deallocate the data in that pool. It cannot do so, because accessible values might still exist. Consuming a pool simply makes it impossible to add new data to the pool.

Given a linear computation that manages memory, run that computation.

'Box a' is the abstract type of manually managed data. It can be used as part of data type definitions in order to store linked data structure off heap. See Foreign.List and Foreign.Pair in the examples directory of the source repository.

Store a value a on the system heap that is not managed by the GC.

Retrieve the value stored on system heap memory.