Distribution-Utils-IOData.html

<!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>Distribution.Utils.IOData</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><link rel="stylesheet" type="text/css" href="quick-jump.css" /><script src="haddock-bundle.min.js" async="async" type="text/javascript"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></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">Cabal-2.4.0.1: A framework for packaging Haskell software</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Distribution.Utils.IOData</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1"><code>IOData</code> &amp; <code>IODataMode</code> type</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p><em>Since: 2.2.0</em></p></div></div><div id="synopsis"><details id="syn"><summary>Synopsis</summary><ul class="details-toggle" data-details-id="syn"><li class="src short"><span class="keyword">data</span> <a href="#t:IOData">IOData</a><ul class="subs"><li>= <a href="#v:IODataText">IODataText</a> <a href="Distribution-Compat-Prelude-Internal.html#t:String" title="Distribution.Compat.Prelude.Internal">String</a></li><li>| <a href="#v:IODataBinary">IODataBinary</a> <a href="file:///opt/ghc/8.4.3/share/doc/ghc-8.4.3/html/libraries/bytestring-0.10.8.2/Data-ByteString-Lazy.html#t:ByteString" title="Data.ByteString.Lazy">ByteString</a></li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:IODataMode">IODataMode</a><ul class="subs"><li>= <a href="#v:IODataModeText">IODataModeText</a></li><li>| <a href="#v:IODataModeBinary">IODataModeBinary</a></li></ul></li><li class="src short"><a href="#v:null">null</a> :: <a href="Distribution-Utils-IOData.html#t:IOData" title="Distribution.Utils.IOData">IOData</a> -&gt; <a href="Distribution-Compat-Prelude-Internal.html#t:Bool" title="Distribution.Compat.Prelude.Internal">Bool</a></li><li class="src short"><a href="#v:hGetContents">hGetContents</a> :: <a href="file:///opt/ghc/8.4.3/share/doc/ghc-8.4.3/html/libraries/base-4.11.1.0/GHC-IO-Handle.html#t:Handle" title="GHC.IO.Handle">Handle</a> -&gt; <a href="Distribution-Utils-IOData.html#t:IODataMode" title="Distribution.Utils.IOData">IODataMode</a> -&gt; <a href="file:///opt/ghc/8.4.3/share/doc/ghc-8.4.3/html/libraries/base-4.11.1.0/System-IO.html#t:IO" title="System.IO">IO</a> <a href="Distribution-Utils-IOData.html#t:IOData" title="Distribution.Utils.IOData">IOData</a></li><li class="src short"><a href="#v:hPutContents">hPutContents</a> :: <a href="file:///opt/ghc/8.4.3/share/doc/ghc-8.4.3/html/libraries/base-4.11.1.0/GHC-IO-Handle.html#t:Handle" title="GHC.IO.Handle">Handle</a> -&gt; <a href="Distribution-Utils-IOData.html#t:IOData" title="Distribution.Utils.IOData">IOData</a> -&gt; <a href="file:///opt/ghc/8.4.3/share/doc/ghc-8.4.3/html/libraries/base-4.11.1.0/System-IO.html#t:IO" title="System.IO">IO</a> ()</li></ul></details></div><div id="interface"><a href="#g:1" id="g:1"><h1><code><a href="Distribution-Utils-IOData.html#t:IOData" title="Distribution.Utils.IOData">IOData</a></code> &amp; <code><a href="Distribution-Utils-IOData.html#t:IODataMode" title="Distribution.Utils.IOData">IODataMode</a></code> type</h1></a><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:IOData" class="def">IOData</a> <a href="#t:IOData" class="selflink">#</a></p><div class="doc"><p>Represents either textual or binary data passed via I/O functions
 which support binary/text mode</p><p><em>Since: 2.2.0</em></p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:IODataText" class="def">IODataText</a> <a href="Distribution-Compat-Prelude-Internal.html#t:String" title="Distribution.Compat.Prelude.Internal">String</a></td><td class="doc"><p>How Text gets encoded is usually locale-dependent.</p></td></tr><tr><td class="src"><a id="v:IODataBinary" class="def">IODataBinary</a> <a href="file:///opt/ghc/8.4.3/share/doc/ghc-8.4.3/html/libraries/bytestring-0.10.8.2/Data-ByteString-Lazy.html#t:ByteString" title="Data.ByteString.Lazy">ByteString</a></td><td class="doc"><p>Raw binary which gets read/written in binary mode.</p></td></tr></table></div><div class="subs instances"><details id="i:IOData" open="open"><summary>Instances</summary><table><tr><td class="src clearfix"><span class="inst-left"><span class="instance details-toggle-control details-toggle" data-details-id="i:id:IOData:NFData:1"></span> <a href="Distribution-Compat-Prelude-Internal.html#t:NFData" title="Distribution.Compat.Prelude.Internal">NFData</a> <a href="Distribution-Utils-IOData.html#t:IOData" title="Distribution.Utils.IOData">IOData</a></span> <a href="#t:IOData" class="selflink">#</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><details id="i:id:IOData:NFData:1"><summary class="hide-when-js-enabled">Instance details</summary><p>Defined in <a href="Distribution-Utils-IOData.html">Distribution.Utils.IOData</a></p> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:rnf">rnf</a> :: <a href="Distribution-Utils-IOData.html#t:IOData" title="Distribution.Utils.IOData">IOData</a> -&gt; () <a href="#v:rnf" class="selflink">#</a></p></div></details></td></tr></table></details></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:IODataMode" class="def">IODataMode</a> <a href="#t:IODataMode" class="selflink">#</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:IODataModeText" class="def">IODataModeText</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a id="v:IODataModeBinary" class="def">IODataModeBinary</a></td><td class="doc empty">&nbsp;</td></tr></table></div></div><div class="top"><p class="src"><a id="v:null" class="def">null</a> :: <a href="Distribution-Utils-IOData.html#t:IOData" title="Distribution.Utils.IOData">IOData</a> -&gt; <a href="Distribution-Compat-Prelude-Internal.html#t:Bool" title="Distribution.Compat.Prelude.Internal">Bool</a> <a href="#v:null" class="selflink">#</a></p><div class="doc"><p>Test whether <code><a href="Distribution-Utils-IOData.html#t:IOData" title="Distribution.Utils.IOData">IOData</a></code> is empty</p><p><em>Since: 2.2.0</em></p></div></div><div class="top"><p class="src"><a id="v:hGetContents" class="def">hGetContents</a> :: <a href="file:///opt/ghc/8.4.3/share/doc/ghc-8.4.3/html/libraries/base-4.11.1.0/GHC-IO-Handle.html#t:Handle" title="GHC.IO.Handle">Handle</a> -&gt; <a href="Distribution-Utils-IOData.html#t:IODataMode" title="Distribution.Utils.IOData">IODataMode</a> -&gt; <a href="file:///opt/ghc/8.4.3/share/doc/ghc-8.4.3/html/libraries/base-4.11.1.0/System-IO.html#t:IO" title="System.IO">IO</a> <a href="Distribution-Utils-IOData.html#t:IOData" title="Distribution.Utils.IOData">IOData</a> <a href="#v:hGetContents" class="selflink">#</a></p><div class="doc"><p><code><a href="Distribution-Utils-IOData.html#t:IOData" title="Distribution.Utils.IOData">IOData</a></code> Wrapper for <code><a href="file:///opt/ghc/8.4.3/share/doc/ghc-8.4.3/html/libraries/base-4.11.1.0/GHC-IO-Handle.html#v:hGetContents" title="GHC.IO.Handle">hGetContents</a></code></p><p><strong>Note</strong>: This operation uses lazy I/O. Use <code><a href="Distribution-Compat-Prelude-Internal.html#t:NFData" title="Distribution.Compat.Prelude.Internal">NFData</a></code> to force all
 data to be read and consequently the internal file handle to be
 closed.</p><p><em>Since: 2.2.0</em></p></div></div><div class="top"><p class="src"><a id="v:hPutContents" class="def">hPutContents</a> :: <a href="file:///opt/ghc/8.4.3/share/doc/ghc-8.4.3/html/libraries/base-4.11.1.0/GHC-IO-Handle.html#t:Handle" title="GHC.IO.Handle">Handle</a> -&gt; <a href="Distribution-Utils-IOData.html#t:IOData" title="Distribution.Utils.IOData">IOData</a> -&gt; <a href="file:///opt/ghc/8.4.3/share/doc/ghc-8.4.3/html/libraries/base-4.11.1.0/System-IO.html#t:IO" title="System.IO">IO</a> () <a href="#v:hPutContents" class="selflink">#</a></p><div class="doc"><p><code><a href="Distribution-Utils-IOData.html#t:IOData" title="Distribution.Utils.IOData">IOData</a></code> Wrapper for <code><a href="file:///opt/ghc/8.4.3/share/doc/ghc-8.4.3/html/libraries/base-4.11.1.0/GHC-IO-Handle.html#v:hPutStr" title="GHC.IO.Handle">hPutStr</a></code> and <code><a href="file:///opt/ghc/8.4.3/share/doc/ghc-8.4.3/html/libraries/base-4.11.1.0/GHC-IO-Handle.html#v:hClose" title="GHC.IO.Handle">hClose</a></code></p><p>This is the dual operation ot <code>ioDataHGetContents</code>,
 and consequently the handle is closed with <code>hClose</code>.</p><p><em>Since: 2.2.0</em></p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.20.0</p></div></body></html>