Data.Primitive.Addr

Primitive operations on machine addresses

Types

data Addr

A machine address

Constructors

Addr Addr#

Instances

Eq Addr

Data Addr

Ord Addr

Typeable Addr

Prim Addr

Address arithmetic

nullAddr :: Addr

The null address

plusAddr :: Addr -> Int -> Addr

Offset an address by the given number of bytes

minusAddr :: Addr -> Addr -> Int

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

remAddr :: Addr -> Int -> Int

The remainder of the address and the integer.

Element access

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

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

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 ()

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.

Block operations

copyAddr

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.

moveAddr

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 overlap.

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

Fill a memory block of with the given value. The length is in elements of type a rather than in bytes.