doc/guide/localhost/MLtonIO

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <meta name="generator" content="AsciiDoc 8.6.9">
   6 <title>MLtonIO</title>
   7 <link rel="stylesheet" href="./asciidoc.css" type="text/css">
   8 <link rel="stylesheet" href="./pygments.css" type="text/css">
   9
  10
  11 <script type="text/javascript" src="./asciidoc.js"></script>
  12 <script type="text/javascript">
  13 /*<![CDATA[*/
  14 asciidoc.install();
  15 /*]]>*/
  16 </script>
  17 <link rel="stylesheet" href="./mlton.css" type="text/css">
  18 </head>
  19 <body class="article">
  20 <div id="banner">
  21 <div id="banner-home">
  22 <a href="./Home">MLton 20180207</a>
  23 </div>
  24 </div>
  25 <div id="header">
  26 <h1>MLtonIO</h1>
  27 </div>
  28 <div id="content">
  29 <div id="preamble">
  30 <div class="sectionbody">
  31 <div class="listingblock">
  32 <div class="content"><div class="highlight"><pre><span class="k">signature</span><span class="w"> </span><span class="n">MLTON_IO</span><span class="w"> </span><span class="p">=</span><span class="w"></span>
  33 <span class="w">   </span><span class="k">sig</span><span class="w"></span>
  34 <span class="w">      </span><span class="k">type</span><span class="w"> </span><span class="n">instream</span><span class="w"></span>
  35 <span class="w">      </span><span class="k">type</span><span class="w"> </span><span class="n">outstream</span><span class="w"></span>
  36
  37 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">inFd</span><span class="p">:</span><span class="w"> </span><span class="n">instream</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">Posix</span><span class="p">.</span><span class="n">IO</span><span class="p">.</span><span class="n">file_desc</span><span class="w"></span>
  38 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">mkstemp</span><span class="p">:</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">outstream</span><span class="w"></span>
  39 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">mkstemps</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="n">prefix</span><span class="p">:</span><span class="w"> </span><span class="n">string</span><span class="p">,</span><span class="w"> </span><span class="n">suffix</span><span class="p">:</span><span class="w"> </span><span class="n">string</span><span class="p">}</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">outstream</span><span class="w"></span>
  40 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">newIn</span><span class="p">:</span><span class="w"> </span><span class="n">Posix</span><span class="p">.</span><span class="n">IO</span><span class="p">.</span><span class="n">file_desc</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">instream</span><span class="w"></span>
  41 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">newOut</span><span class="p">:</span><span class="w"> </span><span class="n">Posix</span><span class="p">.</span><span class="n">IO</span><span class="p">.</span><span class="n">file_desc</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">outstream</span><span class="w"></span>
  42 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">outFd</span><span class="p">:</span><span class="w"> </span><span class="n">outstream</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">Posix</span><span class="p">.</span><span class="n">IO</span><span class="p">.</span><span class="n">file_desc</span><span class="w"></span>
  43 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">tempPrefix</span><span class="p">:</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">string</span><span class="w"></span>
  44 <span class="w">   </span><span class="k">end</span><span class="w"></span>
  45 </pre></div></div></div>
  46 <div class="ulist"><ul>
  47 <li>
  48 <p>
  49 <span class="monospaced">inFd ins</span>
  50 </p>
  51 <div class="paragraph"><p>returns the file descriptor corresponding to <span class="monospaced">ins</span>.</p></div>
  52 </li>
  53 <li>
  54 <p>
  55 <span class="monospaced">mkstemp s</span>
  56 </p>
  57 <div class="paragraph"><p>like the C <span class="monospaced">mkstemp</span> function, generates and open a temporary file
  58 with prefix <span class="monospaced">s</span>.</p></div>
  59 </li>
  60 <li>
  61 <p>
  62 <span class="monospaced">mkstemps {prefix, suffix}</span>
  63 </p>
  64 <div class="paragraph"><p>like <span class="monospaced">mkstemp</span>, except it has both a prefix and suffix.</p></div>
  65 </li>
  66 <li>
  67 <p>
  68 <span class="monospaced">newIn (fd, name)</span>
  69 </p>
  70 <div class="paragraph"><p>creates a new instream from file descriptor <span class="monospaced">fd</span>, with <span class="monospaced">name</span> used in
  71 any <span class="monospaced">Io</span> exceptions later raised.</p></div>
  72 </li>
  73 <li>
  74 <p>
  75 <span class="monospaced">newOut (fd, name)</span>
  76 </p>
  77 <div class="paragraph"><p>creates a new outstream from file descriptor <span class="monospaced">fd</span>, with <span class="monospaced">name</span> used in
  78 any <span class="monospaced">Io</span> exceptions later raised.</p></div>
  79 </li>
  80 <li>
  81 <p>
  82 <span class="monospaced">outFd out</span>
  83 </p>
  84 <div class="paragraph"><p>returns the file descriptor corresponding to <span class="monospaced">out</span>.</p></div>
  85 </li>
  86 <li>
  87 <p>
  88 <span class="monospaced">tempPrefix s</span>
  89 </p>
  90 <div class="paragraph"><p>adds a suitable system or user specific prefix (directory) for temp
  91 files.</p></div>
  92 </li>
  93 </ul></div>
  94 </div>
  95 </div>
  96 </div>
  97 <div id="footnotes"><hr></div>
  98 <div id="footer">
  99 <div id="footer-text">
 100 </div>
 101 <div id="footer-badges">
 102 </div>
 103 </div>
 104 </body>
 105 </html>