Moduleprimitive-addr-0.1.0.3Haskell2010

Data.Primitive.Addr

Primitive operations on machine addresses.

1 type
12 values

Packageprimitive-addr-0.1.0.3
Exports13
LanguageHaskell2010
LicenceBSD-3-Clause
SourceAddr.hs

Types

1 declaration

datadata Addr

A machine address

Constructors

Addr Addr#

Instances3Eq, Ord, Show

Eq AddrDefined in primitive-addr-0.1.0.3 · Data.Primitive.Addr
Ord AddrDefined in primitive-addr-0.1.0.3 · Data.Primitive.Addr
Show AddrDefined in primitive-addr-0.1.0.3 · Data.Primitive.Addr

Address arithmetic

4 declarations

valuenullAddr :: Addr

The null address

valueplusAddr :: Addr -> Int -> Addr

Offset an address by the given number of bytes

valueminusAddr :: Addr -> Addr -> Int

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

valueremAddr :: Addr -> Int -> Int

The remainder of the address and the integer.

Element access

3 declarations

valueindexOffAddr :: 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.

valuereadOffAddr :: (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.

valuewriteOffAddr :: (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

4 declarations

valuecopyAddr

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

valuecopyAddrToByteArray

:: PrimMonad m
=> MutableByteArray (PrimState m)
destination
-> Int
offset into the destination array
-> Addr
source
-> Int
number of bytes to copy
-> m ()

Copy the given number of bytes from the Addr to the MutableByteArray. The areas may not overlap. This function is only available when compiling with GHC 7.8 or newer.

valuemoveAddr

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

valuesetAddr :: (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.

Conversion

1 declaration

valueaddrToInt :: Addr -> Int

Convert an Addr to an Int.