tiny_httpd/ocaml/Unix/LargeFile/index.html
2024-09-27 19:31:31 +00:00

2 lines
7.3 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 (ocaml.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">ocaml</a> &#x00BB; <a href="../index.html">Unix</a> &#x00BB; LargeFile</nav><header class="odoc-preamble"><h1>Module <code><span>Unix.LargeFile</span></code></h1><p>File operations on large files. This sub-module provides 64-bit variants of the functions <a href="../index.html#val-lseek"><code>lseek</code></a> (for positioning a file descriptor), <a href="../index.html#val-truncate"><code>truncate</code></a> and <a href="../index.html#val-ftruncate"><code>ftruncate</code></a> (for changing the size of a file), and <a href="../index.html#val-stat"><code>stat</code></a>, <a href="../index.html#val-lstat"><code>lstat</code></a> and <a href="../index.html#val-fstat"><code>fstat</code></a> (for obtaining information on files). These alternate functions represent positions and sizes by 64-bit integers (type <code>int64</code>) instead of regular integers (type <code>int</code>), thus allowing operating on files whose sizes are greater than <code>max_int</code>.</p></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> int64</span></code></div><div class="spec-doc"><p>See <code>lseek</code>.</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> unit</span></code></div><div class="spec-doc"><p>See <code>truncate</code>.</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> unit</span></code></div><div class="spec-doc"><p>See <code>ftruncate</code>.</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> = </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><div class="def-doc"><span class="comment-delim">(*</span><p>Device number</p><span class="comment-delim">*)</span></div></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><div class="def-doc"><span class="comment-delim">(*</span><p>Inode number</p><span class="comment-delim">*)</span></div></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><div class="def-doc"><span class="comment-delim">(*</span><p>Kind of the file</p><span class="comment-delim">*)</span></div></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><div class="def-doc"><span class="comment-delim">(*</span><p>Access rights</p><span class="comment-delim">*)</span></div></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><div class="def-doc"><span class="comment-delim">(*</span><p>Number of links</p><span class="comment-delim">*)</span></div></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><div class="def-doc"><span class="comment-delim">(*</span><p>User id of the owner</p><span class="comment-delim">*)</span></div></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><div class="def-doc"><span class="comment-delim">(*</span><p>Group ID of the file's group</p><span class="comment-delim">*)</span></div></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><div class="def-doc"><span class="comment-delim">(*</span><p>Device ID (if special file)</p><span class="comment-delim">*)</span></div></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><div class="def-doc"><span class="comment-delim">(*</span><p>Size in bytes</p><span class="comment-delim">*)</span></div></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><div class="def-doc"><span class="comment-delim">(*</span><p>Last access time</p><span class="comment-delim">*)</span></div></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><div class="def-doc"><span class="comment-delim">(*</span><p>Last modification time</p><span class="comment-delim">*)</span></div></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><div class="def-doc"><span class="comment-delim">(*</span><p>Last status change time</p><span class="comment-delim">*)</span></div></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> <a href="#type-stats">stats</a></span></code></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> <a href="#type-stats">stats</a></span></code></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> <a href="#type-stats">stats</a></span></code></div></div></div></body></html>