iter/sequence/SequenceLabels/IO/index.html
2018-01-14 16:45:08 -06:00

11 lines
No EOL
5.2 KiB
HTML

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO (sequence.SequenceLabels.IO)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> &mdash; <span class="package">package <a href="../../index.html">sequence</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">SequenceLabels.IO</span></h1></header><div class="spec val" id="val-lines_of"><a href="#val-lines_of" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>lines_of : ?&#8288;mode:int <span class="keyword">&#8209;&gt;</span> ?&#8288;flags:Pervasives.open_flag list <span class="keyword">&#8209;&gt;</span> string <span class="keyword">&#8209;&gt;</span> string <a href="../index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">lines_of filename</code> reads all lines of the given file. It raises the
same exception as would opening the file and read from it, except
from <code class="code">End_of_file</code> (which is caught). The file is <b>always</b> properly
closed.
Every time the sequence is iterated on, the file is opened again, so
different iterations might return different results</p><ul class="at-tag"><li><span class="at-tag parameter">Parameter</span> <span class="module-path">mode</span>: default <code class="code">0o644</code></li><li><span class="at-tag parameter">Parameter</span> <span class="module-path">flags</span>: default: <code class="code">[Open_rdonly]</code></li></ul></div></div><div class="spec val" id="val-chunks_of"><a href="#val-chunks_of" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>chunks_of : ?&#8288;mode:int <span class="keyword">&#8209;&gt;</span> ?&#8288;flags:Pervasives.open_flag list <span class="keyword">&#8209;&gt;</span> ?&#8288;size:int <span class="keyword">&#8209;&gt;</span> string <span class="keyword">&#8209;&gt;</span> string <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>Read chunks of the given <code class="code">size</code> from the file. The last chunk might be
smaller. Behaves like <a href="index.html#val-lines_of">lines_of</a> regarding errors and options.
Every time the sequence is iterated on, the file is opened again, so
different iterations might return different results</p></div></div><div class="spec val" id="val-write_to"><a href="#val-write_to" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>write_to : ?&#8288;mode:int <span class="keyword">&#8209;&gt;</span> ?&#8288;flags:Pervasives.open_flag list <span class="keyword">&#8209;&gt;</span> string <span class="keyword">&#8209;&gt;</span> string <a href="../index.html#type-t">t</a> <span class="keyword">&#8209;&gt;</span> unit</code></div><div class="doc"><p><code class="code">write_to filename seq</code> writes all strings from <code class="code">seq</code> into the given
file. It takes care of opening and closing the file.</p><ul class="at-tag"><li><span class="at-tag parameter">Parameter</span> <span class="module-path">mode</span>: default <code class="code">0o644</code></li><li><span class="at-tag parameter">Parameter</span> <span class="module-path">flags</span>: used by <code class="code">open_out_gen</code>. Default: <code class="code">[Open_creat;Open_wronly]</code>.</li></ul></div></div><div class="spec val" id="val-write_bytes_to"><a href="#val-write_bytes_to" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>write_bytes_to : ?&#8288;mode:int <span class="keyword">&#8209;&gt;</span> ?&#8288;flags:Pervasives.open_flag list <span class="keyword">&#8209;&gt;</span> string <span class="keyword">&#8209;&gt;</span> Bytes.t <a href="../index.html#type-t">t</a> <span class="keyword">&#8209;&gt;</span> unit</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.5.4</li></ul></div></div><div class="spec val" id="val-write_lines"><a href="#val-write_lines" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>write_lines : ?&#8288;mode:int <span class="keyword">&#8209;&gt;</span> ?&#8288;flags:Pervasives.open_flag list <span class="keyword">&#8209;&gt;</span> string <span class="keyword">&#8209;&gt;</span> string <a href="../index.html#type-t">t</a> <span class="keyword">&#8209;&gt;</span> unit</code></div><div class="doc"><p>Same as <a href="index.html#val-write_to">write_to</a>, but intercales <code class="code">'\n'</code> between each string</p></div></div><div class="spec val" id="val-write_bytes_lines"><a href="#val-write_bytes_lines" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>write_bytes_lines : ?&#8288;mode:int <span class="keyword">&#8209;&gt;</span> ?&#8288;flags:Pervasives.open_flag list <span class="keyword">&#8209;&gt;</span> string <span class="keyword">&#8209;&gt;</span> Bytes.t <a href="../index.html#type-t">t</a> <span class="keyword">&#8209;&gt;</span> unit</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.5.4</li></ul></div></div></body></html>