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>AnnotatedSignature (infer.InferModules.AnnotatedSignature)</title><linkrel="stylesheet"href="../../../odoc.css"/><metacharset="utf-8"/><metaname="generator"content="odoc %%VERSION%%"/><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">InferModules</a>» AnnotatedSignature</nav><h1>Module <code>InferModules.AnnotatedSignature</code></h1></header><aside><p>Method signature with annotations.</p></aside><dl><dtclass="spec type"id="type-t"><ahref="#type-t"class="anchor"></a><code><spanclass="keyword">type</span> t</code><code> = </code><code>{</code><tableclass="record"><trid="type-t.ret"class="anchored"><tdclass="def field"><ahref="#type-t.ret"class="anchor"></a><code>ret : <ahref="../../../InferIR/InferIR/Annot/Item/index.html#type-t">InferIR.Annot.Item.t</a> * <ahref="../../../InferIR/InferIR/Typ/index.html#type-t">InferIR.Typ.t</a>;</code></td><tdclass="doc"><p>Annotated return type.</p></td></tr><trid="type-t.params"class="anchored"><tdclass="def field"><ahref="#type-t.params"class="anchor"></a><code>params : <span><span>(<ahref="../../../InferIR/InferIR/Mangled/index.html#type-t">InferIR.Mangled.t</a> * <ahref="../../../InferIR/InferIR/Annot/Item/index.html#type-t">InferIR.Annot.Item.t</a> * <ahref="../../../InferIR/InferIR/Typ/index.html#type-t">InferIR.Typ.t</a>)</span> list</span>;</code></td><tdclass="doc"><p>Annotated parameters.</p></td></tr></table><code>}</code></dt></dl><div><divclass="spec include"><divclass="doc"><dl><dtclass="spec value"id="val-compare"><ahref="#val-compare"class="anchor"></a><code><spanclass="keyword">val</span> compare : <ahref="index.html#type-t">t</a><span>-></span><ahref="index.html#type-t">t</a><span>-></span> int</code></dt></dl></div></div></div><dl><dtclass="spec type"id="type-annotation"><ahref="#type-annotation"class="anchor"></a><code><spanclass="keyword">type</span> annotation</code><code> = </code><tableclass="variant"><trid="type-annotation.Nullable"class="anchored"><tdclass="def constructor"><ahref="#type-annotation.Nullable"class="anchor"></a><code>| </code><code><spanclass="constructor">Nullable</span></code></td></tr><trid="type-annotation.Present"class="anchored"><tdclass="def constructor"><ahref="#type-annotation.Present"class="anchor"></a><code>| </code><code><spanclass="constructor">Present</span></code></td></tr></table></dt></dl><div><divclass="spec include"><divclass="doc"><dl><dtclass="spec value"id="val-compare_annotation"><ahref="#val-compare_annotation"class="anchor"></a><code><spanclass="keyword">val</span> compare_annotation : <ahref="index.html#type-annotation">annotation</a><span>-></span><ahref="index.html#type-annotation">annotation</a><span>-></span> int</code></dt></dl></div></div></div><dl><dtclass="spec value"id="val-param_has_annot"><ahref="#val-param_has_annot"class="anchor"></a><code><spanclass="keyword">val</span> param_has_annot : <span>(<ahref="../../../InferIR/InferIR/Annot/Item/index.html#type-t">InferIR.Annot.Item.t</a><span>-></span> bool)</span><span>-></span><ahref="../../../InferIR/InferIR/Pvar/index.html#type-t">InferIR.Pvar.t</a><span>-></span><ahref="index.html#type-t">t</a><span>-></span> bool</code></dt><dd><p>Check if the given parameter has an annotation in the given signature</p></dd></dl><dl><dtclass="spec value"id="val-mark"><ahref="#val-mark"class="anchor"></a><code><spanclass="keyword">val</span> mark : <ahref="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a><span>-></span><ahref="index.html#type-annotation">annotation</a><span>-></span><ahref="index.html#type-t">t</a><span>-></span><span>(bool * <span>bool list</span>)</span><span>-></span><ahref="index.html#type-t">t</a></code></dt><dd><p>Mark the annotated signature with the given annotation map.</p></dd></dl><dl><dtclass="spec value"id="val-get"><ahref="#val-get"class="anchor"></a><code><spanclass="keyword">val</span> get : <ahref="../../../InferIR/InferIR/ProcAttributes/index.html#type-t">InferIR.ProcAttributes.t</a><span>-></span><ahref="index.html#type-t">t</a></code></dt><dd><p>Get a method signature with annotations from a proc_attributes.</p></dd></dl><dl><dtclass="spec value"id="val-mk_ia"><ahref="#val-mk_ia"class="anchor"></a><code><spanclass="keyword">val</span> mk_ia : <ahref="index.html#type-annotation">annotation</a><span>-></span><ahref="../../../InferIR/InferIR/Annot/Item/index.html#type-t">InferIR.Annot.Item.t</a><span>-></span><ahref="../../../InferIR/InferIR/Annot/Item/index.html#type-t">InferIR.Annot.Item.t</a></code></dt><dd><p>Add the annotation to the item_annotation.</p></dd></dl><dl><dtclass="spec value"id="val-pp"><ahref="#val-pp"class="anchor"></a><code><spanclass="keyword">val</span> pp : <ahref="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a><span>-></span> Stdlib.Format.formatter <span>-></span><ahref="index.html#type-t">t</a><span>-></span> unit</code></dt><dd><p>Pretty print a method signature with annotations.</p></dd></dl></div></body></html>
