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>PulsePayload (infer.InferModules.PulsePayload)</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>» PulsePayload</nav><h1>Module <code>InferModules.PulsePayload</code></h1></header><div><divclass="spec include"><divclass="doc"><detailsopen="open"><summary><spanclass="def"><code><spanclass="keyword">include</span><ahref="../SummaryPayload/index.html#module-type-S">SummaryPayload.S</a><spanclass="keyword">with</span><spanclass="keyword">type</span><ahref="../SummaryPayload/module-type-S/index.html#type-t">t</a> = <ahref="../PulseSummary/index.html#type-t">PulseSummary.t</a></code></span></summary><dl><dtclass="spec type"id="type-t"><ahref="#type-t"class="anchor"></a><code><spanclass="keyword">type</span> t</code><code> = <ahref="../PulseSummary/index.html#type-t">PulseSummary.t</a></code></dt></dl><dl><dtclass="spec value"id="val-update_summary"><ahref="#val-update_summary"class="anchor"></a><code><spanclass="keyword">val</span> update_summary : <ahref="index.html#type-t">t</a><span>-></span><ahref="../Summary/index.html#type-t">Summary.t</a><span>-></span><ahref="../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><dtclass="spec value"id="val-of_summary"><ahref="#val-of_summary"class="anchor"></a><code><spanclass="keyword">val</span> of_summary : <ahref="../Summary/index.html#type-t">Summary.t</a><span>-></span><span><ahref="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><dtclass="spec value"id="val-read_full"><ahref="#val-read_full"class="anchor"></a><code><spanclass="keyword">val</span> read_full : <span>caller_summary:<ahref="../Summary/index.html#type-t">Summary.t</a></span><span>-></span><span>callee_pname:<ahref="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a></span><span>-></span><span><span>(<ahref="../../../InferIR/InferIR/Procdesc/index.html#type-t">InferIR.Procdesc.t</a> * <ahref="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><dtclass="spec value"id="val-read"><ahref="#val-read"class="anchor"></a><code><spanclass="keyword">val</span> read : <span>caller_summary:<ahref="../Summary/index.html#type-t">Summary.t</a></span><span>-></span><span>callee_pname:<ahref="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a></span><span>-></span><span><ahref="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><dtclass="spec value"id="val-read_toplevel_procedure"><ahref="#val-read_toplevel_procedure"class="anchor"></a><code><spanclass="keyword">val</span> read_toplevel_procedure : <ahref="../../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a><span>-></span><span><ahref="index.html#type-t">t</a> option</span></code></dt></dl></details></div></div></div></div></body></html>
