Foreign.Ptr.Region

Regional pointers

data RegionalPtr α r

A regional handle to memory. This should provide a safer replacement for Foreign.Ptr.Ptr

Instances

Dup (RegionalPtr α)

nullPtr :: RegionalPtr α RootRegion

The constant nullPtr contains a distinguished value of RegionalPtr that is not associated with a valid memory location.

Note that nullPtr is a pure value. This means it does not perform the side-effect of registering a finalizer like free nullPtr in the RegionT monad.

Finally note that the region parameter of the RegionalPtr is set to RootRegion which is the ancestor of any region. This allows nullPtr to be used in any region.

Note that this module re-exports the Control.Monad.Trans.Region module from the regions package which allows you to:

• Run a region using runRegionT.
• Concurrently run a region inside another region using forkIOTopRegion.
• Duplicate a RegionalPtr to a parent region using dup.

module Control.Monad.Trans.Region

Pure functions on regional pointers

mapRegionalPtr :: (Ptr α -> Ptr β) -> RegionalPtr α r -> RegionalPtr β r

Apply a pure function to the inner pointer of a regional pointer.

castPtr :: RegionalPtr α r -> RegionalPtr β r

The castPtr function casts a pointer from one type to another.

Wraps: Foreign.Ptr.castPtr

plusPtr :: RegionalPtr α r -> Int -> RegionalPtr β r

Advances the given address by the given offset in bytes.

Wraps: Foreign.Ptr.plusPtr

alignPtr :: RegionalPtr α r -> Int -> RegionalPtr α r

Given an arbitrary address and an alignment constraint, alignPtr yields the next higher address that fulfills the alignment constraint. An alignment constraint x is fulfilled by any address divisible by x. This operation is idempotent.

Wraps: Foreign.Ptr.alignPtr

minusPtr :: RegionalPtr α r1 -> RegionalPtr β r2 -> Int

Computes the offset required to get from the second to the first argument. We have

 p2 == p1 `plusPtr` (p2 `minusPtr` p1)

Wraps: Foreign.Ptr.minusPtr