tiny_httpd/ocaml/Unit_info/Artifact/index.html
2025-03-21 12:40:14 +00:00

2 lines
3.6 KiB
HTML
Raw Permalink 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>Artifact (ocaml.Unit_info.Artifact)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><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">Index</a> &#x00BB; <a href="../../index.html">ocaml</a> &#x00BB; <a href="../index.html">Unit_info</a> &#x00BB; Artifact</nav><header class="odoc-preamble"><h1>Module <code><span>Unit_info.Artifact</span></code></h1></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#artifact_function">Build artifacts</a></li></ul></nav></div><div class="odoc-content"><h2 id="artifact_function"><a href="#artifact_function" class="anchor"></a>Build artifacts</h2><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div><div class="spec-doc"><p>Metadata for a single compilation artifact:</p><ul><li>the module name associated to the artifact</li><li>the filesystem path</li><li>the input source file if it exists</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-source_file"><a href="#val-source_file" class="anchor"></a><code><span><span class="keyword">val</span> source_file : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-filename">filename</a> option</span></span></code></div><div class="spec-doc"><p><code>source_file a</code> is the source file of <code>a</code> if it exists.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-prefix"><a href="#val-prefix" class="anchor"></a><code><span><span class="keyword">val</span> prefix : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-file_prefix">file_prefix</a></span></code></div><div class="spec-doc"><p><code>prefix a</code> is the filename prefix of the compilation artifact.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-filename"><a href="#val-filename" class="anchor"></a><code><span><span class="keyword">val</span> filename : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-filename">filename</a></span></code></div><div class="spec-doc"><p><code>filename u</code> is the filesystem path for a compilation artifact.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-modname"><a href="#val-modname" class="anchor"></a><code><span><span class="keyword">val</span> modname : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-modname">modname</a></span></code></div><div class="spec-doc"><p><code>modname a</code> is the module name of the compilation artifact.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-from_filename"><a href="#val-from_filename" class="anchor"></a><code><span><span class="keyword">val</span> from_filename : <span><a href="../index.html#type-filename">filename</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>from_filename filename</code> reconstructs the module name <code>modname_from_source filename</code> associated to the artifact <code>filename</code>.</p></div></div></div></body></html>