simon/moonpool
1
0
Fork 0
mirror of https://github.com/c-cube/moonpool.git synced 2026-01-22 09:16:51 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
moonpool/ocaml/Build_path_prefix_map/index.html
c-cube 1830dc8781 deploy: d79200f555
2025-09-26 19:08:06 +00:00

2 lines
6.7 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>Build_path_prefix_map (ocaml.Build_path_prefix_map)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.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; Build_path_prefix_map</nav><header class="odoc-preamble"><h1>Module <code><span>Build_path_prefix_map</span></code></h1><p>Rewrite paths for reproducible builds</p><p><b>Warning:</b> this module is unstable and part of <span class="xref-unresolved" title="Compiler_libs">compiler-libs</span>.</p><p>See <a href="https://reproducible-builds.org/specs/build-path-prefix-map/">the BUILD_PATH_PREFIX_MAP spec</a></p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-path"><a href="#type-path" class="anchor"></a><code><span><span class="keyword">type</span> path</span><span> = string</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-path_prefix"><a href="#type-path_prefix" class="anchor"></a><code><span><span class="keyword">type</span> path_prefix</span><span> = string</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-error_message"><a href="#type-error_message" class="anchor"></a><code><span><span class="keyword">type</span> error_message</span><span> = string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-encode_prefix"><a href="#val-encode_prefix" class="anchor"></a><code><span><span class="keyword">val</span> encode_prefix : <span><a href="#type-path_prefix">path_prefix</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode_prefix"><a href="#val-decode_prefix" class="anchor"></a><code><span><span class="keyword">val</span> decode_prefix : <span>string <span class="arrow">&#45;&gt;</span></span> <span><span>(<a href="#type-path_prefix">path_prefix</a>, <a href="#type-error_message">error_message</a>)</span> <a href="../Stdlib/index.html#type-result">result</a></span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-pair"><a href="#type-pair" class="anchor"></a><code><span><span class="keyword">type</span> pair</span><span> = </span><span>{</span></code><ol><li id="type-pair.target" class="def record field anchored"><a href="#type-pair.target" class="anchor"></a><code><span>target : <a href="#type-path_prefix">path_prefix</a>;</span></code></li><li id="type-pair.source" class="def record field anchored"><a href="#type-pair.source" class="anchor"></a><code><span>source : <a href="#type-path_prefix">path_prefix</a>;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-encode_pair"><a href="#val-encode_pair" class="anchor"></a><code><span><span class="keyword">val</span> encode_pair : <span><a href="#type-pair">pair</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode_pair"><a href="#val-decode_pair" class="anchor"></a><code><span><span class="keyword">val</span> decode_pair : <span>string <span class="arrow">&#45;&gt;</span></span> <span><span>(<a href="#type-pair">pair</a>, <a href="#type-error_message">error_message</a>)</span> <a href="../Stdlib/index.html#type-result">result</a></span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-map"><a href="#type-map" class="anchor"></a><code><span><span class="keyword">type</span> map</span><span> = <span><span><a href="#type-pair">pair</a> option</span> list</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-encode_map"><a href="#val-encode_map" class="anchor"></a><code><span><span class="keyword">val</span> encode_map : <span><a href="#type-map">map</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode_map"><a href="#val-decode_map" class="anchor"></a><code><span><span class="keyword">val</span> decode_map : <span>string <span class="arrow">&#45;&gt;</span></span> <span><span>(<a href="#type-map">map</a>, <a href="#type-error_message">error_message</a>)</span> <a href="../Stdlib/index.html#type-result">result</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-rewrite_first"><a href="#val-rewrite_first" class="anchor"></a><code><span><span class="keyword">val</span> rewrite_first : <span><a href="#type-map">map</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-path">path</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-path">path</a> option</span></span></code></div><div class="spec-doc"><p><code>rewrite_first map path</code> tries to find a source in <code>map</code> that is a prefix of the input <code>path</code>. If it succeeds, it replaces this prefix with the corresponding target. If it fails, it just returns <code>None</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-rewrite_all"><a href="#val-rewrite_all" class="anchor"></a><code><span><span class="keyword">val</span> rewrite_all : <span><a href="#type-map">map</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-path">path</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-path">path</a> list</span></span></code></div><div class="spec-doc"><p><code>rewrite_all map path</code> finds all sources in <code>map</code> that are a prefix of the input <code>path</code>. For each matching source, in priority order, it replaces this prefix with the corresponding target and adds the result to the returned list. If there are no matches, it just returns <code>[]</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-rewrite"><a href="#val-rewrite" class="anchor"></a><code><span><span class="keyword">val</span> rewrite : <span><a href="#type-map">map</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-path">path</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-path">path</a></span></code></div><div class="spec-doc"><p><code>rewrite path</code> uses <code>rewrite_first</code> to try to find a mapping for path. If found, it returns that, otherwise it just returns <code>path</code>.</p></div></div></div></body></html>
Reference in a new issue View git blame Copy permalink