linol/lwt/Lwt_unix/LargeFile/index.html
2024-10-23 20:49:46 +00:00

2 lines
7.1 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>LargeFile (lwt.Lwt_unix.LargeFile)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../index.html">lwt</a> &#x00BB; <a href="../index.html">Lwt_unix</a> &#x00BB; LargeFile</nav><header class="odoc-preamble"><h1>Module <code><span>Lwt_unix.LargeFile</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-lseek"><a href="#val-lseek" class="anchor"></a><code><span><span class="keyword">val</span> lseek : <span><a href="../index.html#type-file_descr">file_descr</a> <span class="arrow">&#45;&gt;</span></span> <span>int64 <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-seek_command">seek_command</a> <span class="arrow">&#45;&gt;</span></span> <span>int64 <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Wrapper for <a href="../../../ocaml/Unix/LargeFile/index.html#val-lseek"><code>Unix.LargeFile.lseek</code></a></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-truncate"><a href="#val-truncate" class="anchor"></a><code><span><span class="keyword">val</span> truncate : <span>string <span class="arrow">&#45;&gt;</span></span> <span>int64 <span class="arrow">&#45;&gt;</span></span> <span>unit <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Wrapper for <a href="../../../ocaml/Unix/LargeFile/index.html#val-truncate"><code>Unix.LargeFile.truncate</code></a></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ftruncate"><a href="#val-ftruncate" class="anchor"></a><code><span><span class="keyword">val</span> ftruncate : <span><a href="../index.html#type-file_descr">file_descr</a> <span class="arrow">&#45;&gt;</span></span> <span>int64 <span class="arrow">&#45;&gt;</span></span> <span>unit <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Wrapper for <a href="../../../ocaml/Unix/LargeFile/index.html#val-ftruncate"><code>Unix.LargeFile.ftruncate</code></a></p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-stats"><a href="#type-stats" class="anchor"></a><code><span><span class="keyword">type</span> stats</span><span> = <a href="../../../ocaml/Unix/LargeFile/index.html#type-stats">Unix.LargeFile.stats</a></span><span> = </span><span>{</span></code><ol><li id="type-stats.st_dev" class="def record field anchored"><a href="#type-stats.st_dev" class="anchor"></a><code><span>st_dev : int;</span></code></li><li id="type-stats.st_ino" class="def record field anchored"><a href="#type-stats.st_ino" class="anchor"></a><code><span>st_ino : int;</span></code></li><li id="type-stats.st_kind" class="def record field anchored"><a href="#type-stats.st_kind" class="anchor"></a><code><span>st_kind : <a href="../index.html#type-file_kind">file_kind</a>;</span></code></li><li id="type-stats.st_perm" class="def record field anchored"><a href="#type-stats.st_perm" class="anchor"></a><code><span>st_perm : <a href="../index.html#type-file_perm">file_perm</a>;</span></code></li><li id="type-stats.st_nlink" class="def record field anchored"><a href="#type-stats.st_nlink" class="anchor"></a><code><span>st_nlink : int;</span></code></li><li id="type-stats.st_uid" class="def record field anchored"><a href="#type-stats.st_uid" class="anchor"></a><code><span>st_uid : int;</span></code></li><li id="type-stats.st_gid" class="def record field anchored"><a href="#type-stats.st_gid" class="anchor"></a><code><span>st_gid : int;</span></code></li><li id="type-stats.st_rdev" class="def record field anchored"><a href="#type-stats.st_rdev" class="anchor"></a><code><span>st_rdev : int;</span></code></li><li id="type-stats.st_size" class="def record field anchored"><a href="#type-stats.st_size" class="anchor"></a><code><span>st_size : int64;</span></code></li><li id="type-stats.st_atime" class="def record field anchored"><a href="#type-stats.st_atime" class="anchor"></a><code><span>st_atime : float;</span></code></li><li id="type-stats.st_mtime" class="def record field anchored"><a href="#type-stats.st_mtime" class="anchor"></a><code><span>st_mtime : float;</span></code></li><li id="type-stats.st_ctime" class="def record field anchored"><a href="#type-stats.st_ctime" class="anchor"></a><code><span>st_ctime : float;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-stat"><a href="#val-stat" class="anchor"></a><code><span><span class="keyword">val</span> stat : <span>string <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-stats">stats</a> <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Wrapper for <a href="../../../ocaml/Unix/LargeFile/index.html#val-stat"><code>Unix.LargeFile.stat</code></a></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-lstat"><a href="#val-lstat" class="anchor"></a><code><span><span class="keyword">val</span> lstat : <span>string <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-stats">stats</a> <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Wrapper for <a href="../../../ocaml/Unix/LargeFile/index.html#val-lstat"><code>Unix.LargeFile.lstat</code></a></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-fstat"><a href="#val-fstat" class="anchor"></a><code><span><span class="keyword">val</span> fstat : <span><a href="../index.html#type-file_descr">file_descr</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-stats">stats</a> <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p>Wrapper for <a href="../../../ocaml/Unix/LargeFile/index.html#val-fstat"><code>Unix.LargeFile.fstat</code></a></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-file_exists"><a href="#val-file_exists" class="anchor"></a><code><span><span class="keyword">val</span> file_exists : <span>string <span class="arrow">&#45;&gt;</span></span> <span>bool <a href="../../Lwt/index.html#type-t">Lwt.t</a></span></span></code></div><div class="spec-doc"><p><code>file_exists name</code> tests if a file named <code>name</code> exists.</p><p>Note that <code>file_exists</code> behaves similarly to <code>Sys.file_exists</code>:</p><ul><li>“file” is interpreted as “directory entry” in this context</li></ul><ul><li><code>file_exists name</code> will return <code>false</code> in circumstances that would make <a href="#val-stat"><code>stat</code></a> raise a <a href="../../../ocaml/Unix/index.html#exception-Unix_error"><code>Unix.Unix_error</code></a> exception.</li></ul></div></div></div></body></html>