Sophie: ghc-base-devel-4.2.0.2-8.6.fc14 x86

ghc-base-devel-4.2.0.2-8.6.fc14.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>GHC.IO.BufferedIO</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock-util.js" TYPE="text/javascript"
></SCRIPT
><SCRIPT TYPE="text/javascript"
>window.onload = function () {setSynopsis("mini_GHC-IO-BufferedIO.html")};</SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
>base-4.2.0.2: Basic libraries</TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>GHC.IO.BufferedIO</FONT
></TD
><TD ALIGN="right"
><TABLE CLASS="narrow" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="infohead"
>Portability</TD
><TD CLASS="infoval"
>non-portable (GHC Extensions)</TD
></TR
><TR
><TD CLASS="infohead"
>Stability</TD
><TD CLASS="infoval"
>internal</TD
></TR
><TR
><TD CLASS="infohead"
>Maintainer</TD
><TD CLASS="infoval"
>cvs-ghc@haskell.org</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
>Class of buffered IO devices
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>class</SPAN
>  <A HREF="#t%3ABufferedIO"
>BufferedIO</A
> dev  <SPAN CLASS="keyword"
>where</SPAN
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="#v%3AnewBuffer"
>newBuffer</A
> :: dev -&gt; <A HREF="GHC-IO-Buffer.html#t%3ABufferState"
>BufferState</A
> -&gt; <A HREF="System-IO.html#t%3AIO"
>IO</A
> (<A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
>)</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfillReadBuffer"
>fillReadBuffer</A
> :: dev -&gt; <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
> -&gt; <A HREF="System-IO.html#t%3AIO"
>IO</A
> (<A HREF="Data-Int.html#t%3AInt"
>Int</A
>, <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
>)</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfillReadBuffer0"
>fillReadBuffer0</A
> :: dev -&gt; <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
> -&gt; <A HREF="System-IO.html#t%3AIO"
>IO</A
> (<A HREF="Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Data-Int.html#t%3AInt"
>Int</A
>, <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
>)</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AemptyWriteBuffer"
>emptyWriteBuffer</A
> :: dev -&gt; <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
> -&gt; <A HREF="System-IO.html#t%3AIO"
>IO</A
> (<A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
>)</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AflushWriteBuffer"
>flushWriteBuffer</A
> :: dev -&gt; <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
> -&gt; <A HREF="System-IO.html#t%3AIO"
>IO</A
> (<A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
>)</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AflushWriteBuffer0"
>flushWriteBuffer0</A
> :: dev -&gt; <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
> -&gt; <A HREF="System-IO.html#t%3AIO"
>IO</A
> (<A HREF="Data-Int.html#t%3AInt"
>Int</A
>, <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
>)</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AreadBuf"
>readBuf</A
> :: <A HREF="GHC-IO-Device.html#t%3ARawIO"
>RawIO</A
> dev =&gt; dev -&gt; <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
> -&gt; <A HREF="System-IO.html#t%3AIO"
>IO</A
> (<A HREF="Data-Int.html#t%3AInt"
>Int</A
>, <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
>)</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AreadBufNonBlocking"
>readBufNonBlocking</A
> :: <A HREF="GHC-IO-Device.html#t%3ARawIO"
>RawIO</A
> dev =&gt; dev -&gt; <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
> -&gt; <A HREF="System-IO.html#t%3AIO"
>IO</A
> (<A HREF="Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Data-Int.html#t%3AInt"
>Int</A
>, <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
>)</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AwriteBuf"
>writeBuf</A
> :: <A HREF="GHC-IO-Device.html#t%3ARawIO"
>RawIO</A
> dev =&gt; dev -&gt; <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
> -&gt; <A HREF="System-IO.html#t%3AIO"
>IO</A
> (<A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
>)</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AwriteBufNonBlocking"
>writeBufNonBlocking</A
> :: <A HREF="GHC-IO-Device.html#t%3ARawIO"
>RawIO</A
> dev =&gt; dev -&gt; <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
> -&gt; <A HREF="System-IO.html#t%3AIO"
>IO</A
> (<A HREF="Data-Int.html#t%3AInt"
>Int</A
>, <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
>)</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Documentation</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>class</SPAN
>  <A NAME="t:BufferedIO"
><A NAME="t%3ABufferedIO"
></A
></A
><B
>BufferedIO</B
> dev  <SPAN CLASS="keyword"
>where</SPAN
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>The purpose of <TT
><A HREF="GHC-IO-BufferedIO.html#t%3ABufferedIO"
>BufferedIO</A
></TT
> is to provide a common interface for I/O
 devices that can read and write data through a buffer.  Devices that
 implement <TT
><A HREF="GHC-IO-BufferedIO.html#t%3ABufferedIO"
>BufferedIO</A
></TT
> include ordinary files, memory-mapped files,
 and bytestrings.  The underlying device implementing a Handle must
 provide <TT
><A HREF="GHC-IO-BufferedIO.html#t%3ABufferedIO"
>BufferedIO</A
></TT
>.
</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="section4"
>Methods</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A NAME="v:newBuffer"
><A NAME="v%3AnewBuffer"
></A
></A
><B
>newBuffer</B
> :: dev -&gt; <A HREF="GHC-IO-Buffer.html#t%3ABufferState"
>BufferState</A
> -&gt; <A HREF="System-IO.html#t%3AIO"
>IO</A
> (<A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
>)</TD
></TR
><TR
><TD CLASS="doc"
>allocate a new buffer.  The size of the buffer is at the
 discretion of the device; e.g. for a memory-mapped file the
 buffer will probably cover the entire file.
</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:fillReadBuffer"
><A NAME="v%3AfillReadBuffer"
></A
></A
><B
>fillReadBuffer</B
> :: dev -&gt; <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
> -&gt; <A HREF="System-IO.html#t%3AIO"
>IO</A
> (<A HREF="Data-Int.html#t%3AInt"
>Int</A
>, <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
>)</TD
></TR
><TR
><TD CLASS="doc"
>reads bytes into the buffer, blocking if there are no bytes
 available.  Returns the number of bytes read (zero indicates
 end-of-file), and the new buffer.
</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:fillReadBuffer0"
><A NAME="v%3AfillReadBuffer0"
></A
></A
><B
>fillReadBuffer0</B
> :: dev -&gt; <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
> -&gt; <A HREF="System-IO.html#t%3AIO"
>IO</A
> (<A HREF="Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Data-Int.html#t%3AInt"
>Int</A
>, <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
>)</TD
></TR
><TR
><TD CLASS="doc"
>reads bytes into the buffer without blocking.  Returns the
 number of bytes read (Nothing indicates end-of-file), and the new
 buffer.
</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:emptyWriteBuffer"
><A NAME="v%3AemptyWriteBuffer"
></A
></A
><B
>emptyWriteBuffer</B
> :: dev -&gt; <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
> -&gt; <A HREF="System-IO.html#t%3AIO"
>IO</A
> (<A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
>)</TD
></TR
><TR
><TD CLASS="doc"
><P
>Prepares an empty write buffer.  This lets the device decide
 how to set up a write buffer: the buffer may need to point to a
 specific location in memory, for example.  This is typically used
 by the client when switching from reading to writing on a
 buffered read/write device.
</P
><P
>There is no corresponding operation for read buffers, because before
 reading the client will always call <TT
><A HREF="GHC-IO-BufferedIO.html#v%3AfillReadBuffer"
>fillReadBuffer</A
></TT
>.
</P
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:flushWriteBuffer"
><A NAME="v%3AflushWriteBuffer"
></A
></A
><B
>flushWriteBuffer</B
> :: dev -&gt; <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
> -&gt; <A HREF="System-IO.html#t%3AIO"
>IO</A
> (<A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
>)</TD
></TR
><TR
><TD CLASS="doc"
>Flush all the data from the supplied write buffer out to the device.
 The returned buffer should be empty, and ready for writing.
</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:flushWriteBuffer0"
><A NAME="v%3AflushWriteBuffer0"
></A
></A
><B
>flushWriteBuffer0</B
> :: dev -&gt; <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
> -&gt; <A HREF="System-IO.html#t%3AIO"
>IO</A
> (<A HREF="Data-Int.html#t%3AInt"
>Int</A
>, <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
>)</TD
></TR
><TR
><TD CLASS="doc"
>Flush data from the supplied write buffer out to the device
 without blocking.  Returns the number of bytes written and the
 remaining buffer.
</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:BufferedIO')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:BufferedIO" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="GHC-IO-BufferedIO.html#t%3ABufferedIO"
>BufferedIO</A
> FD</TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:readBuf"
><A NAME="v%3AreadBuf"
></A
></A
><B
>readBuf</B
> :: <A HREF="GHC-IO-Device.html#t%3ARawIO"
>RawIO</A
> dev =&gt; dev -&gt; <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
> -&gt; <A HREF="System-IO.html#t%3AIO"
>IO</A
> (<A HREF="Data-Int.html#t%3AInt"
>Int</A
>, <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
>)</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:readBufNonBlocking"
><A NAME="v%3AreadBufNonBlocking"
></A
></A
><B
>readBufNonBlocking</B
> :: <A HREF="GHC-IO-Device.html#t%3ARawIO"
>RawIO</A
> dev =&gt; dev -&gt; <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
> -&gt; <A HREF="System-IO.html#t%3AIO"
>IO</A
> (<A HREF="Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Data-Int.html#t%3AInt"
>Int</A
>, <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
>)</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:writeBuf"
><A NAME="v%3AwriteBuf"
></A
></A
><B
>writeBuf</B
> :: <A HREF="GHC-IO-Device.html#t%3ARawIO"
>RawIO</A
> dev =&gt; dev -&gt; <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
> -&gt; <A HREF="System-IO.html#t%3AIO"
>IO</A
> (<A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
>)</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:writeBufNonBlocking"
><A NAME="v%3AwriteBufNonBlocking"
></A
></A
><B
>writeBufNonBlocking</B
> :: <A HREF="GHC-IO-Device.html#t%3ARawIO"
>RawIO</A
> dev =&gt; dev -&gt; <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
> -&gt; <A HREF="System-IO.html#t%3AIO"
>IO</A
> (<A HREF="Data-Int.html#t%3AInt"
>Int</A
>, <A HREF="GHC-IO-Buffer.html#t%3ABuffer"
>Buffer</A
> <A HREF="Data-Word.html#t%3AWord8"
>Word8</A
>)</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 2.6.1</TD
></TR
></TABLE
></BODY
></HTML
>