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

This file contains invisible Unicode characters!

This file contains invisible Unicode characters that may be processed differently from what appears below. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to reveal hidden 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>ModelTables (infer.Nullsafe.ModelTables)</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; <a href="../index.html">Nullsafe</a> &#x00BB; ModelTables</nav><h1>Module <code>Nullsafe.ModelTables</code></h1></header><dl><dt class="spec type" id="type-model_table_t"><a href="#type-model_table_t" class="anchor"></a><code><span class="keyword">type</span> model_table_t</code><code> = <span><span>(string, bool * <span>bool list</span>)</span> <a href="../../IStdlib/index.html#module-IStd">IStdlib.IStd</a>.Caml.Hashtbl.t</span></code></dt></dl><dl><dt class="spec value" id="val-annotated_table_nullability"><a href="#val-annotated_table_nullability" class="anchor"></a><code><span class="keyword">val</span> annotated_table_nullability : <a href="index.html#type-model_table_t">model_table_t</a></code></dt><dt class="spec value" id="val-check_not_null_table"><a href="#val-check_not_null_table" class="anchor"></a><code><span class="keyword">val</span> check_not_null_table : <a href="index.html#type-model_table_t">model_table_t</a></code></dt><dd><p>List of methods known to perform a non-nullable assertion</p></dd></dl><dl><dt class="spec value" id="val-check_not_null_parameter_table"><a href="#val-check_not_null_parameter_table" class="anchor"></a><code><span class="keyword">val</span> check_not_null_parameter_table : <span><span>(string, int)</span> <a href="../../IStdlib/index.html#module-IStd">IStdlib.IStd</a>.Caml.Hashtbl.t</span></code></dt><dd><p>The key is a string representation of a method known to perform a non-nullable assertion. The value is an index (starting from 1) of an argument which nullability is being asserted.</p></dd></dl><dl><dt class="spec value" id="val-check_state_table"><a href="#val-check_state_table" class="anchor"></a><code><span class="keyword">val</span> check_state_table : <a href="index.html#type-model_table_t">model_table_t</a></code></dt><dt class="spec value" id="val-check_argument_table"><a href="#val-check_argument_table" class="anchor"></a><code><span class="keyword">val</span> check_argument_table : <a href="index.html#type-model_table_t">model_table_t</a></code></dt><dt class="spec value" id="val-containsKey_table"><a href="#val-containsKey_table" class="anchor"></a><code><span class="keyword">val</span> containsKey_table : <a href="index.html#type-model_table_t">model_table_t</a></code></dt><dt class="spec value" id="val-mapPut_table"><a href="#val-mapPut_table" class="anchor"></a><code><span class="keyword">val</span> mapPut_table : <a href="index.html#type-model_table_t">model_table_t</a></code></dt><dt class="spec value" id="val-noreturn_table"><a href="#val-noreturn_table" class="anchor"></a><code><span class="keyword">val</span> noreturn_table : <a href="index.html#type-model_table_t">model_table_t</a></code></dt><dt class="spec value" id="val-true_on_null_table"><a href="#val-true_on_null_table" class="anchor"></a><code><span class="keyword">val</span> true_on_null_table : <a href="index.html#type-model_table_t">model_table_t</a></code></dt></dl><dl><dt class="spec type" id="type-nonnull_alternative_method"><a href="#type-nonnull_alternative_method" class="anchor"></a><code><span class="keyword">type</span> nonnull_alternative_method</code><code> = </code><code>{</code><table class="record"><tr id="type-nonnull_alternative_method.package_name" class="anchored"><td class="def field"><a href="#type-nonnull_alternative_method.package_name" class="anchor"></a><code>package_name : string;</code></td></tr><tr id="type-nonnull_alternative_method.class_name" class="anchored"><td class="def field"><a href="#type-nonnull_alternative_method.class_name" class="anchor"></a><code>class_name : string;</code></td></tr><tr id="type-nonnull_alternative_method.method_name" class="anchored"><td class="def field"><a href="#type-nonnull_alternative_method.method_name" class="anchor"></a><code>method_name : string;</code></td></tr></table><code>}</code></dt><dd><p>Used to describe a method complementary to a given one. Contains information needed for reporting (hence does not describe the whole signature).</p></dd></dl><dl><dt class="spec value" id="val-nonnull_alternatives_table"><a href="#val-nonnull_alternatives_table" class="anchor"></a><code><span class="keyword">val</span> nonnull_alternatives_table : <span><span>(string, <a href="index.html#type-nonnull_alternative_method">nonnull_alternative_method</a>)</span> <a href="../../IStdlib/index.html#module-IStd">IStdlib.IStd</a>.Caml.Hashtbl.t</span></code></dt><dd><p>The key is a string representation of a <code>@Nullable</code> method. The value is the description of non-nullable alternative: a method does the same, but never returns null (does a null check inside).</p></dd></dl><dl><dt class="spec value" id="val-field_nullability_table"><a href="#val-field_nullability_table" class="anchor"></a><code><span class="keyword">val</span> field_nullability_table : <span><span>(string, bool)</span> <a href="../../IStdlib/index.html#module-IStd">IStdlib.IStd</a>.Caml.Hashtbl.t</span></code></dt><dd><p>Table of known fields whos nullability is explicitly modelled. Keys are field full names; value <code>true</code> means nullable</p></dd></dl></div></body></html>