<!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.Array.IO.Safe</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-Array-IO-Safe.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">array-0.4.0.0: Mutable and immutable arrays</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>non-portable (uses Data.Array.MArray)</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Maintainer</th><td>libraries@haskell.org</td></tr><tr><th>Safe Haskell</th><td>Trustworthy</td></tr></table><p class="caption">Data.Array.IO.Safe</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1"><code>IO</code> arrays with boxed elements
</a></li><li><a href="#g:2"><code>IO</code> arrays with unboxed elements
</a></li><li><a href="#g:3">Overloaded mutable array interface
</a></li><li><a href="#g:4">Doing I/O with <code>IOUArray</code>s
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Mutable boxed and unboxed arrays in the IO monad.
.
Safe API only of <a href="Data-Array-IO.html">Data.Array.IO</a>.
</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:IOArray">IOArray</a> i e</li><li class="src short"><span class="keyword">data</span> <a href="#t:IOUArray">IOUArray</a> i e</li><li class="src short">module <a href="Data-Array-MArray-Safe.html">Data.Array.MArray.Safe</a></li><li class="src short"><a href="#v:hGetArray">hGetArray</a> :: <a href="../base-4.5.1.0/GHC-IO-Handle.html#t:Handle">Handle</a> -> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> <a href="../base-4.5.1.0/Data-Int.html#t:Int">Int</a> <a href="../base-4.5.1.0/Data-Word.html#t:Word8">Word8</a> -> <a href="../base-4.5.1.0/Data-Int.html#t:Int">Int</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="../base-4.5.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:hPutArray">hPutArray</a> :: <a href="../base-4.5.1.0/GHC-IO-Handle.html#t:Handle">Handle</a> -> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> <a href="../base-4.5.1.0/Data-Int.html#t:Int">Int</a> <a href="../base-4.5.1.0/Data-Word.html#t:Word8">Word8</a> -> <a href="../base-4.5.1.0/Data-Int.html#t:Int">Int</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li></ul></div><div id="interface"><h1 id="g:1"><code>IO</code> arrays with boxed elements
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:IOArray" class="def">IOArray</a> i e <a href="../base-4.5.1.0/src/GHC-IOArray.html#IOArray" class="link">Source</a></p><div class="doc"><p>An <code><a href="Data-Array-IO-Safe.html#t:IOArray">IOArray</a></code> is a mutable, boxed, non-strict array in the <code><a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a></code> monad.
The type arguments are as follows:
</p><ul><li> <code>i</code>: the index type of the array (should be an instance of <code><a href="../base-4.5.1.0/Data-Ix.html#t:Ix">Ix</a></code>)
</li><li> <code>e</code>: the element type of the array.
</li></ul></div><div class="subs instances"><p id="control.i:IOArray" class="caption collapser" onclick="toggleSection('i:IOArray')">Instances</p><div id="section.i:IOArray" class="show"><table><tr><td class="src"><a href="../base-4.5.1.0/Data-Typeable-Internal.html#t:Typeable2">Typeable2</a> <a href="Data-Array-IO-Safe.html#t:IOArray">IOArray</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Array-MArray.html#t:MArray">MArray</a> <a href="Data-Array-IO-Safe.html#t:IOArray">IOArray</a> e <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="../base-4.5.1.0/Data-Eq.html#t:Eq">Eq</a> (<a href="Data-Array-IO-Safe.html#t:IOArray">IOArray</a> i e)</td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:2"><code>IO</code> arrays with unboxed elements
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:IOUArray" class="def">IOUArray</a> i e </p><div class="doc"><p>Mutable, unboxed, strict arrays in the <code><a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a></code> monad. The type
arguments are as follows:
</p><ul><li> <code>i</code>: the index type of the array (should be an instance of <code><a href="../base-4.5.1.0/Data-Ix.html#t:Ix">Ix</a></code>)
</li><li> <code>e</code>: the element type of the array. Only certain element types
are supported: see <a href="Data-Array-MArray.html">Data.Array.MArray</a> for a list of instances.
</li></ul></div><div class="subs instances"><p id="control.i:IOUArray" class="caption collapser" onclick="toggleSection('i:IOUArray')">Instances</p><div id="section.i:IOUArray" class="show"><table><tr><td class="src"><a href="../base-4.5.1.0/Data-Typeable-Internal.html#t:Typeable2">Typeable2</a> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Array-MArray.html#t:MArray">MArray</a> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> <a href="../base-4.5.1.0/Data-Bool.html#t:Bool">Bool</a> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Array-MArray.html#t:MArray">MArray</a> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> <a href="../base-4.5.1.0/Data-Char.html#t:Char">Char</a> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Array-MArray.html#t:MArray">MArray</a> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> <a href="../base-4.5.1.0/Prelude.html#t:Double">Double</a> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Array-MArray.html#t:MArray">MArray</a> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> <a href="../base-4.5.1.0/Prelude.html#t:Float">Float</a> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Array-MArray.html#t:MArray">MArray</a> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> <a href="../base-4.5.1.0/Data-Int.html#t:Int">Int</a> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Array-MArray.html#t:MArray">MArray</a> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> <a href="../base-4.5.1.0/Data-Int.html#t:Int8">Int8</a> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Array-MArray.html#t:MArray">MArray</a> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> <a href="../base-4.5.1.0/Data-Int.html#t:Int16">Int16</a> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Array-MArray.html#t:MArray">MArray</a> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> <a href="../base-4.5.1.0/Data-Int.html#t:Int32">Int32</a> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Array-MArray.html#t:MArray">MArray</a> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> <a href="../base-4.5.1.0/Data-Int.html#t:Int64">Int64</a> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Array-MArray.html#t:MArray">MArray</a> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> <a href="../base-4.5.1.0/Data-Word.html#t:Word">Word</a> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Array-MArray.html#t:MArray">MArray</a> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> <a href="../base-4.5.1.0/Data-Word.html#t:Word8">Word8</a> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Array-MArray.html#t:MArray">MArray</a> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> <a href="../base-4.5.1.0/Data-Word.html#t:Word16">Word16</a> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Array-MArray.html#t:MArray">MArray</a> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> <a href="../base-4.5.1.0/Data-Word.html#t:Word32">Word32</a> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Array-MArray.html#t:MArray">MArray</a> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> <a href="../base-4.5.1.0/Data-Word.html#t:Word64">Word64</a> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Array-MArray.html#t:MArray">MArray</a> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> (<a href="../base-4.5.1.0/Foreign-StablePtr.html#t:StablePtr">StablePtr</a> a) <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Array-MArray.html#t:MArray">MArray</a> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> (<a href="../base-4.5.1.0/Foreign-Ptr.html#t:Ptr">Ptr</a> a) <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Array-MArray.html#t:MArray">MArray</a> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> (<a href="../base-4.5.1.0/Foreign-Ptr.html#t:FunPtr">FunPtr</a> a) <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="../base-4.5.1.0/Data-Eq.html#t:Eq">Eq</a> (<a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> i e)</td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:3">Overloaded mutable array interface
</h1><div class="top"><p class="src">module <a href="Data-Array-MArray-Safe.html">Data.Array.MArray.Safe</a></p></div><h1 id="g:4">Doing I/O with <code>IOUArray</code>s
</h1><div class="top"><p class="src"><a name="v:hGetArray" class="def">hGetArray</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="../base-4.5.1.0/GHC-IO-Handle.html#t:Handle">Handle</a></td><td class="doc"><p>Handle to read from
</p></td></tr><tr><td class="src">-> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> <a href="../base-4.5.1.0/Data-Int.html#t:Int">Int</a> <a href="../base-4.5.1.0/Data-Word.html#t:Word8">Word8</a></td><td class="doc"><p>Array in which to place the values
</p></td></tr><tr><td class="src">-> <a href="../base-4.5.1.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p>Number of <code><a href="../base-4.5.1.0/Data-Word.html#t:Word8">Word8</a></code>s to read
</p></td></tr><tr><td class="src">-> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="../base-4.5.1.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p>Returns: the number of <code><a href="../base-4.5.1.0/Data-Word.html#t:Word8">Word8</a></code>s actually
read, which might be smaller than the number requested
if the end of file was reached.
</p></td></tr></table></div><div class="doc"><p>Reads a number of <code><a href="../base-4.5.1.0/Data-Word.html#t:Word8">Word8</a></code>s from the specified <code><a href="../base-4.5.1.0/GHC-IO-Handle.html#t:Handle">Handle</a></code> directly
into an array.
</p></div></div><div class="top"><p class="src"><a name="v:hPutArray" class="def">hPutArray</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="../base-4.5.1.0/GHC-IO-Handle.html#t:Handle">Handle</a></td><td class="doc"><p>Handle to write to
</p></td></tr><tr><td class="src">-> <a href="Data-Array-IO-Safe.html#t:IOUArray">IOUArray</a> <a href="../base-4.5.1.0/Data-Int.html#t:Int">Int</a> <a href="../base-4.5.1.0/Data-Word.html#t:Word8">Word8</a></td><td class="doc"><p>Array to write from
</p></td></tr><tr><td class="src">-> <a href="../base-4.5.1.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p>Number of <code><a href="../base-4.5.1.0/Data-Word.html#t:Word8">Word8</a></code>s to write
</p></td></tr><tr><td class="src">-> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Writes an array of <code><a href="../base-4.5.1.0/Data-Word.html#t:Word8">Word8</a></code> to the specified <code><a href="../base-4.5.1.0/GHC-IO-Handle.html#t:Handle">Handle</a></code>.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.11.0</p></div></body></html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
6e204a966e8c42d976f99a1700ce5f20
>
files
>
2175
