| Portability | non-portable |
|---|---|
| Maintainer | Roman Leshchinskiy <rl@cse.unsw.edu.au> |
| Safe Haskell | Safe-Infered |
Data.Primitive.Addr
Description
Primitive operations on machine addresses
- 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 ()
- copyAddr :: PrimMonad m => Addr -> Addr -> Int -> m ()
- moveAddr :: PrimMonad m => Addr -> Addr -> Int -> m ()
- memcpyAddr :: PrimMonad m => Addr -> Addr -> Int -> m ()
Documentation
A machine address
minusAddr :: Addr -> Addr -> IntSource
Distance in bytes between two addresses. The result is only valid if the
difference fits in an Int.
indexOffAddr :: Prim a => Addr -> Int -> aSource
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 aSource
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.
Arguments
| :: PrimMonad m | |
| => Addr | destination address |
| -> Addr | source address |
| -> Int | number of bytes |
| -> m () |
Copy the given number of bytes from the second Addr to the first. The
areas may not overlap.