infer_clone/website/static/odoc/next/infer/Nullsafe/DereferenceRule/index.html

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>DereferenceRule (infer.Nullsafe.DereferenceRule)</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; DereferenceRule</nav><h1>Module <code>Nullsafe.DereferenceRule</code></h1></header><aside><p>Dereference rule should be checked every type an object is dereferenced. The rule checks if the reference is nullable.</p></aside><dl><dt class="spec type" id="type-violation"><a href="#type-violation" class="anchor"></a><code><span class="keyword">type</span> violation</code></dt></dl><div><div class="spec include"><div class="doc"><dl><dt class="spec value" id="val-compare_violation"><a href="#val-compare_violation" class="anchor"></a><code><span class="keyword">val</span> compare_violation : <a href="index.html#type-violation">violation</a> <span>&#45;&gt;</span> <a href="index.html#type-violation">violation</a> <span>&#45;&gt;</span> int</code></dt></dl></div></div></div><dl><dt class="spec value" id="val-check"><a href="#val-check" class="anchor"></a><code><span class="keyword">val</span> check : <a href="../InferredNullability/index.html#type-t">InferredNullability.t</a> <span>&#45;&gt;</span> <span><span>(unit, <a href="index.html#type-violation">violation</a>)</span> <a href="../../IStdlib/index.html#module-IStd">IStdlib.IStd</a>.result</span></code></dt><dd><p>violation of Dereference rule reflects possibility of dereferencing of `null`. Note that this might or might not be severe enough to be reported to the user, depending on the mode agreements.</p></dd></dl><dl><dt class="spec module" id="module-ReportableViolation"><a href="#module-ReportableViolation" class="anchor"></a><code><span class="keyword">module</span> <a href="ReportableViolation/index.html">ReportableViolation</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></dt><dd><p>Violation that needs to be reported to the user.</p></dd></dl></div></body></html>
[website] docs for current master Summary: Run `make doc-publish` and adjust links in website/docs/04-internal-API.md to point to odoc/next/infer/infer.html as the starting point of the docs has changed (was: odoc/index.html but now this also contains dead links to sledge and ppx_trace... also infer.mld is a me-written exposé of the various libraries and index.mld is an auto-generated list of all the modules now). Reviewed By: ngorogiannis Differential Revision: D21552864 fbshipit-source-id: c3977f645 5 years ago				`<!DOCTYPE html>`
make new-website-version Summary: Update documentation and add a version for v1.0.0. Reviewed By: martintrojer Differential Revision: D24191031 fbshipit-source-id: 0a57c693e 4 years ago				<html xmlns="http://www.w3.org/1999/xhtml"><head><title>DereferenceRule (infer.Nullsafe.DereferenceRule)</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> » <a href="../index.html">Nullsafe</a> » DereferenceRule</nav><h1>Module <code>Nullsafe.DereferenceRule</code></h1></header><aside><p>Dereference rule should be checked every type an object is dereferenced. The rule checks if the reference is nullable.</p></aside><dl><dt class="spec type" id="type-violation"><a href="#type-violation" class="anchor"></a><code><span class="keyword">type</span> violation</code></dt></dl><div><div class="spec include"><div class="doc"><dl><dt class="spec value" id="val-compare_violation"><a href="#val-compare_violation" class="anchor"></a><code><span class="keyword">val</span> compare_violation : <a href="index.html#type-violation">violation</a> <span>-></span> <a href="index.html#type-violation">violation</a> <span>-></span> int</code></dt></dl></div></div></div><dl><dt class="spec value" id="val-check"><a href="#val-check" class="anchor"></a><code><span class="keyword">val</span> check : <a href="../InferredNullability/index.html#type-t">InferredNullability.t</a> <span>-></span> <span><span>(unit, <a href="index.html#type-violation">violation</a>)</span> <a href="../../IStdlib/index.html#module-IStd">IStdlib.IStd</a>.result</span></code></dt><dd><p>violation of Dereference rule reflects possibility of dereferencing of `null`. Note that this might or might not be severe enough to be reported to the user, depending on the mode agreements.</p></dd></dl><dl><dt class="spec module" id="module-ReportableViolation"><a href="#module-ReportableViolation" class="anchor"></a><code><span class="keyword">module</span> <a href="ReportableViolation/index.html">ReportableViolation</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></dt><dd><p>Violation that needs to be reported to the user.</p></dd></dl></div></body></html>