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

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>PulsePayload (infer.InferModules.PulsePayload)</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; PulsePayload</nav><h1>Module <code>InferModules.PulsePayload</code></h1></header><div><div class="spec include"><div class="doc"><details open="open"><summary><span class="def"><code><span class="keyword">include</span> <a href="../SummaryPayload/index.html#module-type-S">SummaryPayload.S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="../SummaryPayload/module-type-S/index.html#type-t">t</a> = <a href="../PulseSummary/index.html#type-t">PulseSummary.t</a></code></span></summary><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code><code> = <a href="../PulseSummary/index.html#type-t">PulseSummary.t</a></code></dt></dl><dl><dt class="spec value" id="val-update_summary"><a href="#val-update_summary" class="anchor"></a><code><span class="keyword">val</span> update_summary : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="../Summary/index.html#type-t">Summary.t</a> <span>&#45;&gt;</span> <a href="../Summary/index.html#type-t">Summary.t</a></code></dt><dd><p>Update the corresponding part of the payload in the procedure summary</p></dd></dl><dl><dt class="spec value" id="val-of_summary"><a href="#val-of_summary" class="anchor"></a><code><span class="keyword">val</span> of_summary : <a href="../Summary/index.html#type-t">Summary.t</a> <span>&#45;&gt;</span> <span><a href="index.html#type-t">t</a> option</span></code></dt><dd><p>Read the corresponding part of the payload from the procedure summary</p></dd></dl><dl><dt class="spec value" id="val-read_full"><a href="#val-read_full" class="anchor"></a><code><span class="keyword">val</span> read_full : <span>caller_summary:<a href="../Summary/index.html#type-t">Summary.t</a></span> <span>&#45;&gt;</span> <span>callee_pname:<a href="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a></span> <span>&#45;&gt;</span> <span><span>(<a href="../../../InferIR/InferIR/Procdesc/index.html#type-t">InferIR.Procdesc.t</a> * <a href="index.html#type-t">t</a>)</span> option</span></code></dt><dd><p>Return the proc desc and payload for the given procedure. Runs the analysis on-demand if necessary.</p></dd></dl><dl><dt class="spec value" id="val-read"><a href="#val-read" class="anchor"></a><code><span class="keyword">val</span> read : <span>caller_summary:<a href="../Summary/index.html#type-t">Summary.t</a></span> <span>&#45;&gt;</span> <span>callee_pname:<a href="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a></span> <span>&#45;&gt;</span> <span><a href="index.html#type-t">t</a> option</span></code></dt><dd><p>Return the payload for the given procedure. Runs the analysis on-demand if necessary.</p></dd></dl><dl><dt class="spec value" id="val-read_toplevel_procedure"><a href="#val-read_toplevel_procedure" class="anchor"></a><code><span class="keyword">val</span> read_toplevel_procedure : <a href="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a> <span>&#45;&gt;</span> <span><a href="index.html#type-t">t</a> option</span></code></dt></dl></details></div></div></div></div></body></html>