Foreign.Storable.Region

Lifts methods of the Storable type class from Foreign.Storable to regional pointers.

Documentation

peekElemOff :: (AllocatedPointer pointer, Storable α, AncestorRegion pr cr, MonadIO cr) => pointer α pr -> Int -> cr α

Read a value from a memory area regarded as an array of values of the same kind. The first argument specifies the start address of the array and the second the index into the array (the first element of the array has index 0). The following equality holds,

 peekElemOff addr idx = IOExts.fixIO $ \result ->
   peek (addr `plusPtr` (idx * sizeOf result))

Note that this is only a specification, not necessarily the concrete implementation of the function.

Wraps: Foreign.Storable.peekElemOff.

pokeElemOff :: (AllocatedPointer pointer, Storable α, AncestorRegion pr cr, MonadIO cr) => pointer α pr -> Int -> α -> cr ()

Write a value to a memory area regarded as an array of values of the same kind. The following equality holds:

 pokeElemOff addr idx x =
   poke (addr `plusPtr` (idx * sizeOf x)) x

Wraps: Foreign.Storable.pokeElemOff.

peekByteOff :: (AllocatedPointer pointer, Storable α, AncestorRegion pr cr, MonadIO cr) => pointer β pr -> Int -> cr α

Read a value from a memory location given by a base address and offset. The following equality holds:

 peekByteOff addr off = peek (addr `plusPtr` off)

Wraps: Foreign.Storable.peekByteOff.

pokeByteOff :: (AllocatedPointer pointer, Storable α, AncestorRegion pr cr, MonadIO cr) => pointer β pr -> Int -> α -> cr ()

Write a value to a memory location given by a base address and offset. The following equality holds:

 pokeByteOff addr off x = poke (addr `plusPtr` off) x

Wraps: Foreign.Storable.pokeByteOff.

peek :: (AllocatedPointer pointer, Storable α, AncestorRegion pr cr, MonadIO cr) => pointer α pr -> cr α

Read a value from the given memory location.

Note that the peek and poke functions might require properly aligned addresses to function correctly. This is architecture dependent; thus, portable code should ensure that when peeking or poking values of some type a, the alignment constraint for a, as given by the function alignment is fulfilled.

Wraps: Foreign.Storable.peek.

poke :: (AllocatedPointer pointer, Storable α, AncestorRegion pr cr, MonadIO cr) => pointer α pr -> α -> cr ()

Write the given value to the given memory location. Alignment restrictions might apply; see peek.

Wraps: Foreign.Storable.poke.