You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2 lines
6.9 KiB

This file contains ambiguous Unicode characters!

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>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IR__Fieldname (infer.IR__Fieldname)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../index.html">infer</a> &#x00BB; IR__Fieldname</nav><h1>Module <code>IR__Fieldname</code></h1></header><div class="spec module" id="module-F"><a href="#module-F" class="anchor"></a><code><span class="keyword">module</span> F = Stdlib.Format</code></div><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt><dd><p>Names for fields of class/struct/union</p></dd></dl><div><div class="spec include"><div class="doc"><dl><dt class="spec value" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span class="keyword">val</span> compare : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> int</code></dt><dt class="spec value" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span class="keyword">val</span> equal : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> bool</code></dt><dt class="spec value" id="val-yojson_of_t"><a href="#val-yojson_of_t" class="anchor"></a><code><span class="keyword">val</span> yojson_of_t : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> Ppx_yojson_conv_lib.Yojson.Safe.t</code></dt></dl></div></div></div><dl><dt class="spec value" id="val-loose_compare"><a href="#val-loose_compare" class="anchor"></a><code><span class="keyword">val</span> loose_compare : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> int</code></dt><dd><p>Similar to compare, but addresses <code>CStruct x</code> and <code>CppClass x</code> as equal.</p></dd></dl><dl><dt class="spec value" id="val-compare_name"><a href="#val-compare_name" class="anchor"></a><code><span class="keyword">val</span> compare_name : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> int</code></dt><dd><p>Similar to compare, but compares only names, except template arguments.</p></dd></dl><dl><dt class="spec value" id="val-make"><a href="#val-make" class="anchor"></a><code><span class="keyword">val</span> make : <a href="../IR/Typ/Name/index.html#type-t">IR.Typ.Name.t</a> <span>&#45;&gt;</span> string <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p>create a field of the given class and fieldname</p></dd></dl><dl><dt class="spec value" id="val-get_class_name"><a href="#val-get_class_name" class="anchor"></a><code><span class="keyword">val</span> get_class_name : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="../IR/Typ/Name/index.html#type-t">IR.Typ.Name.t</a></code></dt><dt class="spec value" id="val-get_field_name"><a href="#val-get_field_name" class="anchor"></a><code><span class="keyword">val</span> get_field_name : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> string</code></dt><dt class="spec value" id="val-is_java"><a href="#val-is_java" class="anchor"></a><code><span class="keyword">val</span> is_java : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> bool</code></dt><dt class="spec value" id="val-is_java_synthetic"><a href="#val-is_java_synthetic" class="anchor"></a><code><span class="keyword">val</span> is_java_synthetic : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> bool</code></dt><dd><p>Check if the field is autogenerated/synthetic *</p></dd></dl><dl><dt class="spec value" id="val-is_internal"><a href="#val-is_internal" class="anchor"></a><code><span class="keyword">val</span> is_internal : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> bool</code></dt><dd><p>Check if the field has the prefix &quot;__&quot; or &quot;_M_&quot; (internal field of std::thread::id)</p></dd></dl><dl><dt class="spec module" id="module-Set"><a href="#module-Set" class="anchor"></a><code><span class="keyword">module</span> Set : <a href="../IStdlib/index.html#module-IStd">IStdlib.IStd</a>.Caml.Set.S <span class="keyword">with</span> <span class="keyword">type</span> <a href="index.html#module-Set">Set</a>.elt = <a href="index.html#type-t">t</a></code></dt><dd><p>Set for fieldnames</p></dd></dl><dl><dt class="spec module" id="module-Map"><a href="#module-Map" class="anchor"></a><code><span class="keyword">module</span> Map : <a href="../IStdlib/index.html#module-IStd">IStdlib.IStd</a>.Caml.Map.S <span class="keyword">with</span> <span class="keyword">type</span> <a href="index.html#module-Map">Map</a>.key = <a href="index.html#type-t">t</a></code></dt><dd><p>Map for fieldnames</p></dd></dl><dl><dt class="spec value" id="val-is_java_outer_instance"><a href="#val-is_java_outer_instance" class="anchor"></a><code><span class="keyword">val</span> is_java_outer_instance : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> bool</code></dt><dd><p>Check if the field is the synthetic this$n of a nested class, used to access the n-th outer instance.</p></dd></dl><dl><dt class="spec value" id="val-to_string"><a href="#val-to_string" class="anchor"></a><code><span class="keyword">val</span> to_string : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> string</code></dt><dd><p>Convert a field name to a string.</p></dd></dl><dl><dt class="spec value" id="val-to_full_string"><a href="#val-to_full_string" class="anchor"></a><code><span class="keyword">val</span> to_full_string : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> string</code></dt><dt class="spec value" id="val-to_simplified_string"><a href="#val-to_simplified_string" class="anchor"></a><code><span class="keyword">val</span> to_simplified_string : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> string</code></dt><dd><p>Convert a fieldname to a simplified string with at most one-level path.</p></dd></dl><dl><dt class="spec value" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span class="keyword">val</span> pp : <a href="index.html#module-F">F</a>.formatter <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> unit</code></dt><dd><p>Pretty print a field name.</p></dd></dl><div class="spec module" id="module-Normalizer"><a href="#module-Normalizer" class="anchor"></a><code><span class="keyword">module</span> <a href="Normalizer/index.html">Normalizer</a> : <a href="../IStdlib/HashNormalizer/index.html#module-type-S">IStdlib.HashNormalizer.S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="../IStdlib/HashNormalizer/module-type-S/index.html#type-t">t</a> = <a href="index.html#type-t">t</a></code></div></div></body></html>