Data.Primitive.Addr

primitive-addr-0.1.0.3: Addresses to unmanaged memory

Safe Haskell | None
Language | Haskell2010

Data.Primitive.Addr

Contents

- Types
- Address arithmetic
- Element access
- Block operations
- Conversion

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 ()
- copyAddr :: PrimMonad m => Addr -> Addr -> Int -> m ()
- copyAddrToByteArray :: PrimMonad m => MutableByteArray (PrimState m) -> Int -> Addr -> Int -> m ()
- moveAddr :: PrimMonad m => Addr -> Addr -> Int -> m ()
- setAddr :: (Prim a, PrimMonad m) => Addr -> Int -> a -> m ()
- addrToInt :: Addr -> Int

# Types

data Addr #

A machine address

Constructors

Addr Addr# |

#### Instances

Instances details

Show Addr # |
Instance details Defined in Data.Primitive.Addr Methods showsPrec :: Int -> Addr -> ShowS # show :: Addr -> String # showList :: [Addr] -> ShowS #
Eq Addr # |
Instance details Defined in Data.Primitive.Addr Methods (==) :: Addr -> Addr -> Bool # (/=) :: Addr -> Addr -> Bool #
Ord Addr # |
Instance details Defined in Data.Primitive.Addr Methods compare :: Addr -> Addr -> Ordering # (<) :: Addr -> Addr -> Bool # (<=) :: Addr -> Addr -> Bool # (>) :: Addr -> Addr -> Bool # (>=) :: Addr -> Addr -> Bool # max :: Addr -> Addr -> Addr # min :: Addr -> Addr -> Addr #

# Address arithmetic

nullAddr :: Addr #

The null address

plusAddr :: Addr -> Int -> Addr infixl 6 #

Offset an address by the given number of bytes

minusAddr :: Addr -> Addr -> Int infixl 6 #

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

remAddr :: Addr -> Int -> Int infixl 7 #

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.

copyAddrToByteArray #

Arguments

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

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.

# Conversion

addrToInt :: Addr -> Int #

Convert an `Addr` to an `Int`.