primitive-0.3: Wrappers for primitive operations Source code Contents Index

Data.Primitive.Addr Portability non-portable Maintainer Roman Leshchinskiy <rl@cse.unsw.edu.au>

Description

Primitive operations on machine addresses

Synopsis

data Addr = Addr Addr# nullAddr :: Addr plusAddr :: Addr -> Int -> Addr minusAddr :: Addr -> Addr -> Int remAddr :: Addr -> Int -> Int indexOffAddr :: Prim a => Addr -> Int -> a readOffAddr :: (Prim a, PrimMonad m) => Addr -> Int -> m a writeOffAddr :: (Prim a, PrimMonad m) => Addr -> Int -> a -> m ()

Documentation

data Addr Source

A machine address Constructors Addr Addr#

nullAddr :: Addr Source

The null address

plusAddr :: Addr -> Int -> Addr Source

Offset an address by the given number of bytes

minusAddr :: Addr -> Addr -> Int Source

Distance in bytes between two addresses. The result is only valid if the difference fits in an Int.

remAddr :: Addr -> Int -> Int Source

indexOffAddr :: Prim a => Addr -> Int -> a Source

Read a value from a memory position given by an address and an offset. The memory block the address refers to must be immutable. The offset is in elements of type a rather than in bytes.

readOffAddr :: (Prim a, PrimMonad m) => Addr -> Int -> m a Source

Read a value from a memory position given by an address and an offset. The offset is in elements of type a rather than in bytes.

writeOffAddr :: (Prim a, PrimMonad m) => Addr -> Int -> a -> m () Source

Write a value to a memory position given by an address and an offset. The offset is in elements of type a rather than in bytes.

Produced by Haddock version 2.6.0