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