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>InferModules__RacerDModels (infer.InferModules__RacerDModels)</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>» InferModules__RacerDModels</nav><h1>Module <code>InferModules__RacerDModels</code></h1></header><dl><dtclass="spec type"id="type-container_access"><ahref="#type-container_access"class="anchor"></a><code><spanclass="keyword">type</span> container_access</code><code> = </code><tableclass="variant"><trid="type-container_access.ContainerRead"class="anchored"><tdclass="def constructor"><ahref="#type-container_access.ContainerRead"class="anchor"></a><code>| </code><code><spanclass="constructor">ContainerRead</span></code></td></tr><trid="type-container_access.ContainerWrite"class="anchored"><tdclass="def constructor"><ahref="#type-container_access.ContainerWrite"class="anchor"></a><code>| </code><code><spanclass="constructor">ContainerWrite</span></code></td></tr></table></dt></dl><dl><dtclass="spec value"id="val-get_container_access"><ahref="#val-get_container_access"class="anchor"></a><code><spanclass="keyword">val</span> get_container_access : <ahref="../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a><span>-></span><ahref="../../InferIR/InferIR/Tenv/index.html#type-t">InferIR.Tenv.t</a><span>-></span><span><ahref="index.html#type-container_access">container_access</a> option</span></code></dt><dd><p>return Some (access) if this procedure accesses the contents of a container (e.g., Map.get)</p></dd></dl><dl><dtclass="spec value"id="val-has_return_annot"><ahref="#val-has_return_annot"class="anchor"></a><code><spanclass="keyword">val</span> has_return_annot : <span>(<ahref="../../InferIR/InferIR/Annot/Item/index.html#type-t">InferIR.Annot.Item.t</a><span>-></span> bool)</span><span>-></span><ahref="../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a><span>-></span> bool</code></dt><dtclass="spec value"id="val-is_functional"><ahref="#val-is_functional"class="anchor"></a><code><spanclass="keyword">val</span> is_functional : <ahref="../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a><span>-></span> bool</code></dt><dtclass="spec value"id="val-acquires_ownership"><ahref="#val-acquires_ownership"class="anchor"></a><code><spanclass="keyword">val</span> acquires_ownership : <ahref="../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a><span>-></span><ahref="../../InferIR/InferIR/Tenv/index.html#type-t">InferIR.Tenv.t</a><span>-></span> bool</code></dt><dtclass="spec value"id="val-is_box"><ahref="#val-is_box"class="anchor"></a><code><spanclass="keyword">val</span> is_box : <ahref="../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a><span>-></span> bool</code></dt><dd><p>return true if the given procname boxes a primitive type into a reference type</p></dd></dl><dl><dtclass="spec value"id="val-is_thread_confined_method"><ahref="#val-is_thread_confined_method"class="anchor"></a><code><spanclass="keyword">val</span> is_thread_confined_method : <ahref="../../InferIR/InferIR/Tenv/index.html#type-t">InferIR.Tenv.t</a><span>-></span><ahref="../../InferIR/InferIR/Procdesc/index.html#type-t">InferIR.Procdesc.t</a><span>-></span> bool</code></dt><dd><p>Methods in @ThreadConfined classes and methods annotated with @ThreadConfined are assumed to all run on the same thread. For the moment we won't warn on accesses resulting from use of such methods at all. In future we should account for races between these methods and methods from completely different classes that don't necessarily run on the same thread as the confined object.</p></dd></dl><dl><dtclass="spec value"id="val-should_analyze_proc"><ahref="#val-should_analyze_proc"class="anchor"></a><code><spanclass="keyword">val</span> should_analyze_proc : <ahref="../../InferIR/InferIR/Procdesc/index.html#type-t">InferIR.Procdesc.t</a><span>-></span><ahref="../../InferIR/InferIR/Tenv/index.html#type-t">InferIR.Tenv.t</a><span>-></span> bool</code></dt><dd><p>return true if we should compute a summary for the procedure. if this returns false, we won't analyze the procedure or report any warnings on it. note: in the future, we will want to analyze the procedures in all of these cases in order to find more bugs. this is just a temporary measure to avoid obvious false positives</p></dd></dl><dl><dtclass="spec value"id="val-get_current_class_and_threadsafe_superclasses"><ahref="#val-get_current_class_and_threadsafe_superclasses"class="anchor"></a><code><spanclass="keyword">val</span> get_current_class_and_threadsafe_superclasses : <ahref="../../InferIR/InferIR/Tenv/index.html#type-t">InferIR.Tenv.t</a><span>-></span><ahref="../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a><span>-></span><span><span>(<ahref="../../InferIR/InferIR/Typ/index.html#type-name">InferIR.Typ.name</a> * <span><ahref="../../InferIR/InferIR/Typ/index.html#type-name">InferIR.Typ.name</a> list</span>)</span> option</span></code></dt><dtclass="spec value"id="val-is_thread_safe_method"><ahref="#val-is_thread_safe_method"class="anchor"></a><code><spanclass="keyword">val</span> is_thread_safe_method : <ahref="../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a><span>-></span><ahref="../../InferIR/InferIR/Tenv/index.html#type-t">InferIR.Tenv.t</a><span>-></span> bool</code></dt><dd><p>returns true if method or overriden method in superclass is @ThreadSafe, @ThreadSafe(enableChecks = true), or is defined as an alias of @ThreadSafe in a .inferconfig file.</p></dd></dl><dl><dtclass="spec value"id="val-is_marked_thread_safe"><ahref="#val-is_marked_thread_safe"class="anchor"></a><code><spanclass="keyword">val</span> is_marked_thread_safe : <ahref="../../InferIR/InferIR/Procdesc/index.html#type-t">InferIR.Procdesc.t</a><span>-></span><ahref="../../InferIR/InferIR/Tenv/index.html#type-t">InferIR.Tenv.t</a><span>-></span> bool</code></dt><dtclass="spec value"id="val-is_safe_access"><ahref="#val-is_safe_access"class="anchor"></a><code><spanclass="keyword">val</span> is_safe_access : <ahref="../../InferIR/InferIR/AccessPath/index.html#type-access">InferIR.AccessPath.access</a><span>-></span><ahref="../../InferIR/InferIR/AccessPath/index.html#type-t">InferIR.AccessPath.t</a><span>-></span><ahref="../../InferIR/InferIR/Tenv/index.html#type-t">InferIR.Tenv.t</a><span>-></span> bool</code></dt><dd><p>check if an access to a field is thread-confined, or whether the field is volatile</p></dd></dl><dl><dtclass="spec value"id="val-should_flag_interface_call"><ahref="#val-should_flag_interface_call"class="anchor"></a><code><spanclass="keyword">val</span> should_flag_interface_call : <ahref="../../InferIR/InferIR/Tenv/index.html#type-t">InferIR.Tenv.t</a><span>-></span><span><ahref="../../InferIR/InferIR/HilExp/index.html#type-t">InferIR.HilExp.t</a> list</span><span>-></span><ahref="../../InferIR/InferIR/CallFlags/index.html#type-t">InferIR.CallFlags.t</a><span>-></span><ahref="../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a><span>-></span> bool</code></dt><dd><p>should an interface call be flagged as potentially non-thread safe?</p></dd></dl><dl><dtclass="spec value"id="val-is_synchronized_container"><ahref="#val-is_synchronized_container"class="anchor"></a><code><spanclass="keyword">val</span> is_synchronized_container : <ahref="../../InferIR/InferIR/Typ/Procname/index.html#type-t">InferIR.Typ.Procname.t</a><span>-></span><ahref="../../InferIR/InferIR/AccessPath/index.html#type-t">InferIR.AccessPath.t</a><span>-></span><ahref="../../InferIR/InferIR/Tenv/index.html#type-t">InferIR.Tenv.t</a><span>-></span> bool</code></dt><dd><p>is a call on an access path to a method of a synchronized container?</p></dd></dl></div></body></html>
