<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Data.Primitive.Addr</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Data-Primitive-Addr.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Data-Primitive-Addr.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">primitive-0.3.1: Wrappers for primitive operations</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>non-portable</td></tr><tr><th>Maintainer</th><td>Roman Leshchinskiy <rl@cse.unsw.edu.au></td></tr></table><p class="caption">Data.Primitive.Addr</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Primitive operations on machine addresses
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:Addr">Addr</a> = <a href="#v:Addr">Addr</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Prim.html#t:Addr-35-">Addr#</a></li><li class="src short"><a href="#v:nullAddr">nullAddr</a> :: <a href="Data-Primitive-Addr.html#t:Addr">Addr</a></li><li class="src short"><a href="#v:plusAddr">plusAddr</a> :: <a href="Data-Primitive-Addr.html#t:Addr">Addr</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Data-Primitive-Addr.html#t:Addr">Addr</a></li><li class="src short"><a href="#v:minusAddr">minusAddr</a> :: <a href="Data-Primitive-Addr.html#t:Addr">Addr</a> -> <a href="Data-Primitive-Addr.html#t:Addr">Addr</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:remAddr">remAddr</a> :: <a href="Data-Primitive-Addr.html#t:Addr">Addr</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:indexOffAddr">indexOffAddr</a> :: <a href="Data-Primitive-Types.html#t:Prim">Prim</a> a => <a href="Data-Primitive-Addr.html#t:Addr">Addr</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> a</li><li class="src short"><a href="#v:readOffAddr">readOffAddr</a> :: (<a href="Data-Primitive-Types.html#t:Prim">Prim</a> a, <a href="Control-Monad-Primitive.html#t:PrimMonad">PrimMonad</a> m) => <a href="Data-Primitive-Addr.html#t:Addr">Addr</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> m a</li><li class="src short"><a href="#v:writeOffAddr">writeOffAddr</a> :: (<a href="Data-Primitive-Types.html#t:Prim">Prim</a> a, <a href="Control-Monad-Primitive.html#t:PrimMonad">PrimMonad</a> m) => <a href="Data-Primitive-Addr.html#t:Addr">Addr</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> a -> m <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:memcpyAddr">memcpyAddr</a> :: <a href="Control-Monad-Primitive.html#t:PrimMonad">PrimMonad</a> m => <a href="Data-Primitive-Addr.html#t:Addr">Addr</a> -> <a href="Data-Primitive-Addr.html#t:Addr">Addr</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> m <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Addr" class="def">Addr</a> <a href="src/Data-Primitive-Types.html#Addr" class="link">Source</a></p><div class="doc"><p>A machine address
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Addr" class="def">Addr</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Prim.html#t:Addr-35-">Addr#</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Addr" class="caption collapser" onclick="toggleSection('i:Addr')">Instances</p><div id="section.i:Addr" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Data-Primitive-Addr.html#t:Addr">Addr</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Data.html#t:Data">Data</a> <a href="Data-Primitive-Addr.html#t:Addr">Addr</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Ord.html#t:Ord">Ord</a> <a href="Data-Primitive-Addr.html#t:Addr">Addr</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Typeable.html#t:Typeable">Typeable</a> <a href="Data-Primitive-Addr.html#t:Addr">Addr</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Primitive-Types.html#t:Prim">Prim</a> <a href="Data-Primitive-Addr.html#t:Addr">Addr</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:nullAddr" class="def">nullAddr</a> :: <a href="Data-Primitive-Addr.html#t:Addr">Addr</a><a href="src/Data-Primitive-Addr.html#nullAddr" class="link">Source</a></p><div class="doc"><p>The null address
</p></div></div><div class="top"><p class="src"><a name="v:plusAddr" class="def">plusAddr</a> :: <a href="Data-Primitive-Addr.html#t:Addr">Addr</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Data-Primitive-Addr.html#t:Addr">Addr</a><a href="src/Data-Primitive-Addr.html#plusAddr" class="link">Source</a></p><div class="doc"><p>Offset an address by the given number of bytes
</p></div></div><div class="top"><p class="src"><a name="v:minusAddr" class="def">minusAddr</a> :: <a href="Data-Primitive-Addr.html#t:Addr">Addr</a> -> <a href="Data-Primitive-Addr.html#t:Addr">Addr</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a><a href="src/Data-Primitive-Addr.html#minusAddr" class="link">Source</a></p><div class="doc"><p>Distance in bytes between two addresses. The result is only valid if the
difference fits in an <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:remAddr" class="def">remAddr</a> :: <a href="Data-Primitive-Addr.html#t:Addr">Addr</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a><a href="src/Data-Primitive-Addr.html#remAddr" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:indexOffAddr" class="def">indexOffAddr</a> :: <a href="Data-Primitive-Types.html#t:Prim">Prim</a> a => <a href="Data-Primitive-Addr.html#t:Addr">Addr</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> a<a href="src/Data-Primitive-Addr.html#indexOffAddr" class="link">Source</a></p><div class="doc"><p>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 <code>a</code> rather than in bytes.
</p></div></div><div class="top"><p class="src"><a name="v:readOffAddr" class="def">readOffAddr</a> :: (<a href="Data-Primitive-Types.html#t:Prim">Prim</a> a, <a href="Control-Monad-Primitive.html#t:PrimMonad">PrimMonad</a> m) => <a href="Data-Primitive-Addr.html#t:Addr">Addr</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> m a<a href="src/Data-Primitive-Addr.html#readOffAddr" class="link">Source</a></p><div class="doc"><p>Read a value from a memory position given by an address and an offset.
The offset is in elements of type <code>a</code> rather than in bytes.
</p></div></div><div class="top"><p class="src"><a name="v:writeOffAddr" class="def">writeOffAddr</a> :: (<a href="Data-Primitive-Types.html#t:Prim">Prim</a> a, <a href="Control-Monad-Primitive.html#t:PrimMonad">PrimMonad</a> m) => <a href="Data-Primitive-Addr.html#t:Addr">Addr</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> a -> m <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Data-Primitive-Addr.html#writeOffAddr" class="link">Source</a></p><div class="doc"><p>Write a value to a memory position given by an address and an offset.
The offset is in elements of type <code>a</code> rather than in bytes.
</p></div></div><div class="top"><p class="src"><a name="v:memcpyAddr" class="def">memcpyAddr</a> :: <a href="Control-Monad-Primitive.html#t:PrimMonad">PrimMonad</a> m => <a href="Data-Primitive-Addr.html#t:Addr">Addr</a> -> <a href="Data-Primitive-Addr.html#t:Addr">Addr</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> m <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Data-Primitive-Addr.html#memcpyAddr" class="link">Source</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
