mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
14 lines
No EOL
11 KiB
HTML
14 lines
No EOL
11 KiB
HTML
<!DOCTYPE html>
|
|
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>File (containers.CCIO.File)</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> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCIO.File</span></h1></header><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>t</code><code><span class="keyword"> = </span>string</code><code></code></div><div class="doc"><p>A file should be represented by its absolute path, but currently
|
|
this is not enforced.</p></div></div><div class="spec val" id="val-to_string"><a href="#val-to_string" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_string : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string</code></div><div class="doc"></div></div><div class="spec val" id="val-make"><a href="#val-make" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>make : string <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Build a file representation from a path (absolute or relative).</p></div></div><div class="spec val" id="val-exists"><a href="#val-exists" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>exists : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"></div></div><div class="spec val" id="val-is_directory"><a href="#val-is_directory" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>is_directory : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"></div></div><div class="spec val" id="val-remove_exn"><a href="#val-remove_exn" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>remove_exn : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">remove_exn path</code> tries to remove the file at <code class="code">path</code> from the
|
|
file system.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: if there is no file at <code class="code">path</code> or access rights are wrong.</li><li><span class="at-tag since">Since</span>: 0.8</li></ul></div></div><div class="spec val" id="val-remove"><a href="#val-remove" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>remove : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit <a href="../index.html#type-or_error">or_error</a></code></div><div class="doc"><p>Like <code class="code">remove_exn</code> but with an error monad.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.8</li></ul></div></div><div class="spec val" id="val-remove_noerr"><a href="#val-remove_noerr" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>remove_noerr : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Like <code class="code">remove_exn</code> but do not raise any exception on failure.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.8</li></ul></div></div><div class="spec val" id="val-read_dir"><a href="#val-read_dir" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>read_dir : ?⁠recurse:bool <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <a href="../index.html#type-gen">gen</a></code></div><div class="doc"><p><code class="code">read_dir d</code> returns a sequence of files and directory contained
|
|
in the directory <code class="code">d</code> (or an empty stream if <code class="code">d</code> is not a directory).</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error (e.g. permission denied).</li><li><span class="at-tag parameter">Parameter</span> <span class="module-path">recurse</span>: if true (default <code class="code">false</code>), sub-directories are also
|
|
explored.</li></ul></div></div><div class="spec val" id="val-read_exn"><a href="#val-read_exn" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>read_exn : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string</code></div><div class="doc"><p>Read the content of the given file, or raises some exception.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error.</li><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-read"><a href="#val-read" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>read : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string <a href="../index.html#type-or_error">or_error</a></code></div><div class="doc"><p>Read the content of the given file.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-append_exn"><a href="#val-append_exn" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>append_exn : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Append the given string into the given file, possibly raising.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error.</li><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-append"><a href="#val-append" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>append : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string <span class="keyword">‑></span> unit <a href="../index.html#type-or_error">or_error</a></code></div><div class="doc"><p>Append the given string into the given file.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-write_exn"><a href="#val-write_exn" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>write_exn : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Write the given string into the given file, possibly raising.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error.</li><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-write"><a href="#val-write" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>write : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string <span class="keyword">‑></span> unit <a href="../index.html#type-or_error">or_error</a></code></div><div class="doc"><p>Write the given string into the given file.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec type" id="type-walk_item"><a href="#type-walk_item" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>walk_item</code><code><span class="keyword"> = </span>[ `File | `Dir ]<span class="keyword"> * </span><a href="index.html#type-t">t</a></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-walk"><a href="#val-walk" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>walk : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-walk_item">walk_item</a> <a href="../index.html#type-gen">gen</a></code></div><div class="doc"><p>Similar to <a href="index.html#val-read_dir">read_dir</a> (with <code class="code">recurse=true</code>), this function walks
|
|
a directory recursively and yields either files or directories.
|
|
Is a file anything that doesn't satisfy <a href="index.html#val-is_directory">is_directory</a> (including
|
|
symlinks, etc.)</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error (e.g. permission denied) during iteration.</li></ul></div></div><div class="spec val" id="val-walk_l"><a href="#val-walk_l" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>walk_l : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-walk_item">walk_item</a> list</code></div><div class="doc"><p>Like <a href="index.html#val-walk">walk</a> but returns a list (therefore it's eager and might
|
|
take some time on large directories).</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.1</li></ul></div></div><div class="spec val" id="val-show_walk_item"><a href="#val-show_walk_item" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>show_walk_item : <a href="index.html#type-walk_item">walk_item</a> <span class="keyword">‑></span> string</code></div><div class="doc"></div></div><div class="spec val" id="val-with_temp"><a href="#val-with_temp" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>with_temp : ?⁠temp_dir:string <span class="keyword">‑></span> prefix:string <span class="keyword">‑></span> suffix:string <span class="keyword">‑></span> (string <span class="keyword">‑></span> <span class="type-var">'a</span>) <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p><code class="code">with_temp ~prefix ~suffix f</code> will call <code class="code">f</code> with the name of a new
|
|
temporary file (located in <code class="code">temp_dir</code>).
|
|
After <code class="code">f</code> returns, the file is deleted. Best to be used in
|
|
combination with <a href="../index.html#val-with_out">with_out</a>.
|
|
See <span class="xref-unresolved" title="unresolved reference to "Filename.temp_file"">Filename.temp_file</span>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div></body></html> |