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

This file contains ambiguous Unicode characters!

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>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Pulselib__PulseTrace (infer.Pulselib__PulseTrace)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><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; Pulselib__PulseTrace</nav><h1>Module <code>Pulselib__PulseTrace</code></h1></header><div class="spec module" id="module-F"><a href="#module-F" class="anchor"></a><code><span class="keyword">module</span> F = Stdlib.Format</code></div><div class="spec module" id="module-CallEvent"><a href="#module-CallEvent" class="anchor"></a><code><span class="keyword">module</span> CallEvent = <a href="../Pulselib/index.html#module-PulseCallEvent">Pulselib.PulseCallEvent</a></code></div><div class="spec module" id="module-ValueHistory"><a href="#module-ValueHistory" class="anchor"></a><code><span class="keyword">module</span> ValueHistory = <a href="../Pulselib/index.html#module-PulseValueHistory">Pulselib.PulseValueHistory</a></code></div><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><table class="variant"><tr id="type-t.Immediate" class="anchored"><td class="def constructor"><a href="#type-t.Immediate" class="anchor"></a><code>| </code><code><span class="constructor">Immediate</span> <span class="keyword">of</span> </code><code>{</code><table class="record"><tr id="type-t.location" class="anchored"><td class="def field"><a href="#type-t.location" class="anchor"></a><code>location : <a href="../IBase/Location/index.html#type-t">IBase.Location.t</a>;</code></td></tr><tr id="type-t.history" class="anchored"><td class="def field"><a href="#type-t.history" class="anchor"></a><code>history : <a href="../Pulselib/PulseValueHistory/index.html#type-t">ValueHistory.t</a>;</code></td></tr></table><code>}</code></td></tr><tr id="type-t.ViaCall" class="anchored"><td class="def constructor"><a href="#type-t.ViaCall" class="anchor"></a><code>| </code><code><span class="constructor">ViaCall</span> <span class="keyword">of</span> </code><code>{</code><table class="record"><tr id="type-t.f" class="anchored"><td class="def field"><a href="#type-t.f" class="anchor"></a><code>f : <a href="../Pulselib/PulseCallEvent/index.html#type-t">CallEvent.t</a>;</code></td></tr><tr id="type-t.location" class="anchored"><td class="def field"><a href="#type-t.location" class="anchor"></a><code>location : <a href="../IBase/Location/index.html#type-t">IBase.Location.t</a>;</code></td><td class="doc"><p>location of the call event</p></td></tr><tr id="type-t.history" class="anchored"><td class="def field"><a href="#type-t.history" class="anchor"></a><code>history : <a href="../Pulselib/PulseValueHistory/index.html#type-t">ValueHistory.t</a>;</code></td><td class="doc"><p>the call involves a value with this prior history</p></td></tr><tr id="type-t.in_call" class="anchored"><td class="def field"><a href="#type-t.in_call" class="anchor"></a><code>in_call : <a href="index.html#type-t">t</a>;</code></td><td class="doc"><p>last step of the trace is in a call to <code>f</code> made at <code>location</code></p></td></tr></table><code>}</code></td></tr></table></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><dt class="spec value" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span class="keyword">val</span> equal : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> bool</code></dt></dl></div></div></div><dl><dt class="spec value" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span class="keyword">val</span> pp : <span>pp_immediate:<span>(<a href="index.html#module-F">F</a>.formatter <span>&#45;&gt;</span> unit)</span></span> <span>&#45;&gt;</span> <a href="index.html#module-F">F</a>.formatter <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> unit</code></dt><dt class="spec value" id="val-get_outer_location"><a href="#val-get_outer_location" class="anchor"></a><code><span class="keyword">val</span> get_outer_location : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="../IBase/Location/index.html#type-t">IBase.Location.t</a></code></dt><dd><p>skip histories and go straight to the where the action is: either the action itself or the call that leads to the action</p></dd></dl><dl><dt class="spec value" id="val-get_start_location"><a href="#val-get_start_location" class="anchor"></a><code><span class="keyword">val</span> get_start_location : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="../IBase/Location/index.html#type-t">IBase.Location.t</a></code></dt><dd><p>initial step in the history if not empty, or else same as <a href="index.html#val-get_outer_location"><code>get_outer_location</code></a></p></dd></dl><dl><dt class="spec value" id="val-add_to_errlog"><a href="#val-add_to_errlog" class="anchor"></a><code><span class="keyword">val</span> add_to_errlog : <span>?&#8288;include_value_history:bool</span> <span>&#45;&gt;</span> <span>nesting:int</span> <span>&#45;&gt;</span> <span>pp_immediate:<span>(<a href="index.html#module-F">F</a>.formatter <span>&#45;&gt;</span> unit)</span></span> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <span><a href="../Absint/Errlog/index.html#type-loc_trace_elem">Absint.Errlog.loc_trace_elem</a> list</span> <span>&#45;&gt;</span> <span><a href="../Absint/Errlog/index.html#type-loc_trace_elem">Absint.Errlog.loc_trace_elem</a> list</span></code></dt><dt class="spec value" id="val-find_map"><a href="#val-find_map" class="anchor"></a><code><span class="keyword">val</span> find_map : <span>f:<span>(<a href="../Pulselib/PulseValueHistory/index.html#type-event">ValueHistory.event</a> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> option</span>)</span></span> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> option</span></code></dt><dd><p>Like <code>List.find_map</code>, but applies to value histories.</p></dd></dl></div></body></html>