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
5.5 KiB

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>AnnotatedSignature (infer.InferModules.AnnotatedSignature)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><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; <a href="../index.html">InferModules</a> &#x00BB; AnnotatedSignature</nav><h1>Module <code>InferModules.AnnotatedSignature</code></h1></header><aside><p>Method signature with annotations.</p></aside><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code><code> = </code><code>{</code><table class="record"><tr id="type-t.ret" class="anchored"><td class="def field"><a href="#type-t.ret" class="anchor"></a><code>ret : <a href="../../../InferIR/InferIR/Annot/Item/index.html#type-t">InferIR.Annot.Item.t</a> * <a href="../../../InferIR/InferIR/Typ/index.html#type-t">InferIR.Typ.t</a>;</code></td><td class="doc"><p>Annotated return type.</p></td></tr><tr id="type-t.params" class="anchored"><td class="def field"><a href="#type-t.params" class="anchor"></a><code>params : <span><span>(<a href="../../../InferIR/InferIR/Mangled/index.html#type-t">InferIR.Mangled.t</a> * <a href="../../../InferIR/InferIR/Annot/Item/index.html#type-t">InferIR.Annot.Item.t</a> * <a href="../../../InferIR/InferIR/Typ/index.html#type-t">InferIR.Typ.t</a>)</span> list</span>;</code></td><td class="doc"><p>Annotated parameters.</p></td></tr></table><code>}</code></dt></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></dl></div></div></div><dl><dt class="spec type" id="type-annotation"><a href="#type-annotation" class="anchor"></a><code><span class="keyword">type</span> annotation</code><code> = </code><table class="variant"><tr id="type-annotation.Nullable" class="anchored"><td class="def constructor"><a href="#type-annotation.Nullable" class="anchor"></a><code>| </code><code><span class="constructor">Nullable</span></code></td></tr><tr id="type-annotation.Present" class="anchored"><td class="def constructor"><a href="#type-annotation.Present" class="anchor"></a><code>| </code><code><span class="constructor">Present</span></code></td></tr></table></dt></dl><div><div class="spec include"><div class="doc"><dl><dt class="spec value" id="val-compare_annotation"><a href="#val-compare_annotation" class="anchor"></a><code><span class="keyword">val</span> compare_annotation : <a href="index.html#type-annotation">annotation</a> <span>&#45;&gt;</span> <a href="index.html#type-annotation">annotation</a> <span>&#45;&gt;</span> int</code></dt></dl></div></div></div><dl><dt class="spec value" id="val-param_has_annot"><a href="#val-param_has_annot" class="anchor"></a><code><span class="keyword">val</span> param_has_annot : <span>(<a href="../../../InferIR/InferIR/Annot/Item/index.html#type-t">InferIR.Annot.Item.t</a> <span>&#45;&gt;</span> bool)</span> <span>&#45;&gt;</span> <a href="../../../InferIR/InferIR/Pvar/index.html#type-t">InferIR.Pvar.t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> bool</code></dt><dd><p>Check if the given parameter has an annotation in the given signature</p></dd></dl><dl><dt class="spec value" id="val-mark"><a href="#val-mark" class="anchor"></a><code><span class="keyword">val</span> mark : <a href="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a> <span>&#45;&gt;</span> <a href="index.html#type-annotation">annotation</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <span>(bool *