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>Summary (infer.Backend.Summary)</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">Backend</a>» Summary</nav><h1>Module <code>Backend.Summary</code></h1></header><aside><p>Procedure summaries: the results of the capture and all the analysis for a single procedure, plus some statistics</p></aside><divclass="spec module"id="module-Stats"><ahref="#module-Stats"class="anchor"></a><code><spanclass="keyword">module</span><ahref="Stats/index.html">Stats</a> : <spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></div><divclass="spec module"id="module-Status"><ahref="#module-Status"class="anchor"></a><code><spanclass="keyword">module</span><ahref="Status/index.html">Status</a> : <spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></div><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.payloads"class="anchored"><tdclass="def field"><ahref="#type-t.payloads"class="anchor"></a><code>payloads : <ahref="../Payloads/index.html#type-t">Payloads.t</a>;</code></td></tr><trid="type-t.sessions"class="anchored"><tdclass="def field"><ahref="#type-t.sessions"class="anchor"></a><code><spanclass="keyword">mutable</span> sessions : int;</code></td><tdclass="doc"><p>Session number: how many nodes went through symbolic execution</p></td></tr><trid="type-t.stats"class="anchored"><tdclass="def field"><ahref="#type-t.stats"class="anchor"></a><code>stats : <ahref="Stats/index.html#type-t">Stats.t</a>;</code></td></tr><trid="type-t.status"class="anchored"><tdclass="def field"><ahref="#type-t.status"class="anchor"></a><code>status : <ahref="Status/index.html#type-t">Status.t</a>;</code></td></tr><trid="type-t.proc_desc"class="anchored"><tdclass="def field"><ahref="#type-t.proc_desc"class="anchor"></a><code>proc_desc : <ahref="../../IR/Procdesc/index.html#type-t">IR.Procdesc.t</a>;</code></td></tr><trid="type-t.err_log"class="anchored"><tdclass="def field"><ahref="#type-t.err_log"class="anchor"></a><code>err_log : <ahref="../../Absint/Errlog/index.html#type-t">Absint.Errlog.t</a>;</code></td><tdclass="doc"><p>Those are issues that are detected for this procedure after per-procedure analysis. In addition to that there can be errors detected after file-level analysis (next stage after per-procedure analysis). This latter category of errors should NOT be written here, use <code>IssueLog</code> and its serialization capabilities instead.</p></td></tr><trid="type-t.callee_pnames"class="anchored"><tdclass="def field"><ahref="#type-t.callee_pnames"class="anchor"></a><code><spanclass="keyword">mutable</span> callee_pnames : <ahref="../../IR__Procname/index.html#module-Set">IR.Procname.Set</a>.t;</code></td></tr></table><code>}</code></dt><dd><p>summary of a procedure name</p></dd></dl><div><divclass="spec include"><divclass="doc"><dl><dtclass="spec value"id="val-yojson_of_t"><ahref="#val-yojson_of_t"class="anchor"></a><code><spanclass="keyword">val</span> yojson_of_t : <ahref="index.html#type-t">t</a><span>-></span> Ppx_yojson_conv_lib.Yojson.Safe.t</code></dt></dl></div></div></div><dl><dtclass="spec value"id="val-get_proc_name"><ahref="#val-get_proc_name"class="anchor"></a><code><spanclass="keyword">val</span> get_proc_name : <ahref="index.html#type-t">t</a><span>-></span><ahref="../../IR/Procname/index.html#type-t">IR.Procname.t</a></code></dt><dd><p>Get the procedure name</p></dd></dl><dl><dtclass="spec value"id="val-get_proc_desc"><ahref="#val-get_proc_desc"class="anchor"></a><code><spanclass="keyword">val</span> get_proc_desc : <ahref="index.html#type-t">t</a><span>-></span><ahref="../../IR/Procdesc/index.html#type-t">IR.Procdesc.t</a></code></dt><dtclass="spec value"id="val-get_err_log"><ahref="#val-get_err_log"class="anchor"></a><code><spanclass="keyword">val</span> get_err_log : <ahref="index.html#type-t">t</a><span>-></span><ahref="../../Absint/Errlog/index.html#type-t">Absint.Errlog.t</a></code></dt><dtclass="spec value"id="val-get_status"><ahref="#val-get_status"class="anchor"></a><code><spanclass="keyword">val</span> get_status : <ahref="index.html#type-t">t</a><span>-></span><ahref="Status/index.html#type-t">Status.t</a></code></dt><dd><p>Return the status (active v.s. inactive) of a procedure summary</p></dd></dl><dl><dtclass="spec value"id="val-pp_html"><ahref="#val-pp_html"class="anchor"></a><code><spanclass="keyword">val</span> pp_html : <ahref="../../IBase/SourceFile/index.html#type-t">IBase.SourceFile.t</a><span>-></span> Stdlib.Format.formatter <span>-></span><ahref="index.html#type-t">t</a><span>-></span> unit</code></dt><dd><p>Print the summary in html format</p></dd></dl><dl><dtclass="spec value"id="val-pp_text"><ahref="#val-pp_text"class="anchor"></a><code><spanclass="keyword">val</span> pp_text : Stdlib.Format.formatter <span>-></span><ahref="index.html#type-t">t</a><span>-></span> unit</code></dt><dd><p>Print the summary in text format</p></dd></dl><divclass="spec module"id="module-OnDisk"><ahref="#module-OnDisk"class="anchor"></a><code><spanclass="keyword">module</span><ahref="OnDisk/index.html">OnDisk</a> : <spanclass="keyword">sig</span> ... <spanclass="keyword">end</span></code></div></div></body></html>
