This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.
<!DOCTYPE html>
<htmlxmlns="http://www.w3.org/1999/xhtml"><head><title>DB (infer.IBase.DB)</title><linkrel="stylesheet"href="../../../odoc.css"/><metacharset="utf-8"/><metaname="generator"content="odoc 1.5.1"/><metaname="viewport"content="width=device-width,initial-scale=1.0"/><scriptsrc="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><divclass="content"><header><nav><ahref="../index.html">Up</a>–<ahref="../../index.html">infer</a>»<ahref="../index.html">IBase</a>» DB</nav><h1>Module <code>IBase.DB</code></h1><navclass="toc"><ul><li><ahref="#filename">Filename</a></li><li><ahref="#results-directory">Results Directory</a></li><li><ahref="#source-dirs">Source Dirs</a></li></ul></nav></header><aside><p>Database of analysis results</p></aside><section><header><h3id="filename"><ahref="#filename"class="anchor"></a>Filename</h3></header><dl><dtclass="spec type"id="type-filename"><ahref="#type-filename"class="anchor"></a><code><spanclass="keyword">type</span> filename</code></dt><dd><p>generic file name</p></dd></dl><div><divclass="spec include"><divclass="doc"><dl><dtclass="spec value"id="val-compare_filename"><ahref="#val-compare_filename"class="anchor"></a><code><spanclass="keyword">val</span> compare_filename : <ahref="index.html#type-filename">filename</a><span>-></span><ahref="index.html#type-filename">filename</a><span>-></span> int</code></dt></dl></div></div></div><dl><dtclass="spec value"id="val-filename_from_string"><ahref="#val-filename_from_string"class="anchor"></a><code><spanclass="keyword">val</span> filename_from_string : string <span>-></span><ahref="index.html#type-filename">filename</a></code></dt><dtclass="spec value"id="val-filename_to_string"><ahref="#val-filename_to_string"class="anchor"></a><code><spanclass="keyword">val</span> filename_to_string : <ahref="index.html#type-filename">filename</a><span>-></span> string</code></dt><dtclass="spec value"id="val-filename_add_suffix"><ahref="#val-filename_add_suffix"class="anchor"></a><code><spanclass="keyword">val</span> filename_add_suffix : <ahref="index.html#type-filename">filename</a><span>-></span> string <span>-></span><ahref="index.html#type-filename">filename</a></code></dt><dtclass="spec value"id="val-file_exists"><ahref="#val-file_exists"class="anchor"></a><code><spanclass="keyword">val</span> file_exists : <ahref="index.html#type-filename">filename</a><span>-></span> bool</code></dt><dtclass="spec value"id="val-file_modified_time"><ahref="#val-file_modified_time"class="anchor"></a><code><spanclass="keyword">val</span> file_modified_time : <span>?⁠symlink:bool</span><span>-></span><ahref="index.html#type-filename">filename</a><span>-></span> float</code></dt><dd><p>Return the time when a file was last modified. The file must exist.</p></dd></dl></section><section><header><h3id="results-directory"><ahref="#results-directory"class="anchor"></a>Results Directory</h3></header><divclass="spec module"id="module-Results_dir"><ahref="#module-Results_dir"class="anchor"></a><code><spanclass="keyword">module</span><ahref="Results_dir/index.html">Results_dir</a> : <spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></div><dl><dtclass="spec value"id="val-append_crc_cutoff"><ahref="#val-append_crc_cutoff"class="anchor"></a><code><spanclass="keyword">val</span> append_crc_cutoff : <span>?⁠key:string</span><span>-></span> string <span>-></span> string * string</code></dt><dd><p>Append a crc to the string, using string_crc_hex32. Cut the string if it exceeds the cutoff limit. Use an optional key to compute the crc. Return a pair of the appended result and crc string.</p></dd></dl><dl><dtclass="spec value"id="val-source_file_encoding"><ahref="#val-source_file_encoding"class="anchor"></a><code><spanclass="keyword">val</span> source_file_encoding : <ahref="../SourceFile/index.html#type-t">SourceFile.t</a><span>-></span> string</code></dt><dd><p>string encoding of a source file (including path) as a single filename</p></dd></dl></section><section><header><h3id="source-dirs"><ahref="#source-dirs"class="anchor"></a>Source Dirs</h3></header><dl><dtclass="spec type"id="type-source_dir"><ahref="#type-source_dir"class="anchor"></a><code><spanclass="keyword">type</span> source_dir</code></dt><dd><p>source directory: the directory inside the results dir corresponding to a source file</p></dd></dl><div><divclass="spec include"><divclass="doc"><dl><dtclass="spec value"id="val-compare_source_dir"><ahref="#val-compare_source_dir"class="anchor"></a><code><spanclass="keyword">val</span> compare_source_dir : <ahref="index.html#type-source_dir">source_dir</a><span>-></span><ahref="index.html#type-source_dir">source_dir</a><span>-></span> int</code></dt></dl></div></div></div><dl><dtclass="spec value"id="val-source_dir_get_internal_file"><ahref="#val-source_dir_get_internal_file"class="anchor"></a><code><spanclass="keyword">val</span> source_dir_get_internal_file : <ahref="index.html#type-source_dir">source_dir</a><span>-></span> string <span>-></span><ahref="index.html#type-filename">filename</a></code></dt><dd><p>get the path to an internal file with the given extention (.tenv, ...)</p></dd></dl><dl><dtclass="spec value"id="val-source_dir_from_source_file"><ahref="#val-source_dir_from_source_file"class="anchor"></a><code><spanclass="keyword">val</span> source_dir_from_source_file : <ahref="../SourceFile/index.html#type-t">SourceFile.t</a><span>-></span><ahref="index.html#type-source_dir">source_dir</a></code></dt><dd><p>get the source directory corresponding to a source file</p></dd></dl><dl><dtclass="spec value"id="val-is_source_file"><ahref="#val-is_source_file"class="anchor"></a><code><spanclass="keyword">val</span> is_source_file : string <span>-></span> bool</code></dt><dd><p>Check if a path is a Java, C, C++ or Objectve C source file according to the file extention</p></dd></dl></section></div></body></html>
