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>BufferOverrunField (infer.BO.BufferOverrunField)</title><linkrel="stylesheet"href="../../../odoc.css"/><metacharset="utf-8"/><metaname="generator"content="odoc 1.5.1"/><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">BO</a>» BufferOverrunField</nav><h1>Module <code>BO.BufferOverrunField</code></h1><navclass="toc"><ul><li><ahref="#inferbo-specific-constant-field-names">Inferbo-specific constant field names</a></li><li><ahref="#field-domain-constructor">Field domain constructor</a></li></ul></nav></header><section><header><h3id="inferbo-specific-constant-field-names"><ahref="#inferbo-specific-constant-field-names"class="anchor"></a>Inferbo-specific constant field names</h3></header><dl><dtclass="spec value"id="val-pp"><ahref="#val-pp"class="anchor"></a><code><spanclass="keyword">val</span> pp : <span>pp_lhs:<span>(Stdlib.Format.formatter <span>-></span><spanclass="type-var">'a</span><span>-></span> unit)</span></span><span>-></span><span>sep:string</span><span>-></span> Stdlib.Format.formatter <span>-></span><spanclass="type-var">'a</span><span>-></span><ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a><span>-></span> unit</code></dt><dd><p>A parameterized pretty printer for field appended values</p></dd></dl><dl><dtclass="spec value"id="val-get_type"><ahref="#val-get_type"class="anchor"></a><code><spanclass="keyword">val</span> get_type : <ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a><span>-></span><span><ahref="../../IR/Typ/index.html#type-t">IR.Typ.t</a> option</span></code></dt><dd><p>Get type of field that is constructed in this module. This does not work in Java at the moment.</p></dd></dl><dl><dtclass="spec value"id="val-c_strlen"><ahref="#val-c_strlen"class="anchor"></a><code><spanclass="keyword">val</span> c_strlen : unit <span>-></span><ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a></code></dt><dd><p>Field for C string's length</p></dd></dl><dl><dtclass="spec value"id="val-cpp_vector_elem"><ahref="#val-cpp_vector_elem"class="anchor"></a><code><spanclass="keyword">val</span> cpp_vector_elem : <span>vec_typ:<ahref="../../IR/Typ/index.html#type-t">IR.Typ.t</a></span><span>-></span><span>elt_typ:<ahref="../../IR/Typ/index.html#type-t">IR.Typ.t</a></span><span>-></span><ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a></code></dt><dd><p>Field for C++ vector's elements</p></dd></dl><dl><dtclass="spec value"id="val-java_collection_internal_array"><ahref="#val-java_collection_internal_array"class="anchor"></a><code><spanclass="keyword">val</span> java_collection_internal_array : <ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a></code></dt><dd><p>Field for Java collection's elements</p></dd></dl><dl><dtclass="spec value"id="val-java_linked_list_index"><ahref="#val-java_linked_list_index"class="anchor"></a><code><spanclass="keyword">val</span> java_linked_list_index : <ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a></code></dt><dd><p>Virtual field for index of Java's linked list</p></dd></dl><dl><dtclass="spec value"id="val-java_linked_list_length"><ahref="#val-java_linked_list_length"class="anchor"></a><code><spanclass="keyword">val</span> java_linked_list_length : <ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a></code></dt><dd><p>Virtual field for length of Java's linked list</p></dd></dl><dl><dtclass="spec value"id="val-java_linked_list_next"><ahref="#val-java_linked_list_next"class="anchor"></a><code><spanclass="keyword">val</span> java_linked_list_next : <ahref="../../IR/Typ/index.html#type-t">IR.Typ.t</a><span>-></span><ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a></code></dt><dd><p>Virtual field for next of Java's linked list</p></dd></dl><dl><dtclass="spec value"id="val-java_list_files_length"><ahref="#val-java_list_files_length"class="anchor"></a><code><spanclass="keyword">val</span> java_list_files_length : <ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a></code></dt><dd><p>Virtual field for length of Java's files list in a directory</p></dd></dl><dl><dtclass="spec value"id="val-is_cpp_vector_elem"><ahref="#val-is_cpp_vector_elem"class="anchor"></a><code><spanclass="keyword">val</span> is_cpp_vector_elem : <ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a><span>-></span> bool</code></dt><dd><p>Check if the field is for C++ vector's elements</p></dd></dl><dl><dtclass="spec value"id="val-is_java_collection_internal_array"><ahref="#val-is_java_collection_internal_array"class="anchor"></a><code><spanclass="keyword">val</span> is_java_collection_internal_array : <ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a><span>-></span> bool</code></dt><dd><p>Check if the field is for Java collection's elements</p></dd></dl><dl><dtclass="spec value"id="val-objc_collection_internal_array"><ahref="#val-objc_collection_internal_array"class="anchor"></a><code><spanclass="keyword">val</span> objc_collection_internal_array : <ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a></code></dt><dd><p>Field for ObjC's collection's elements</p></dd></dl><dl><dtclass="spec value"id="val-objc_iterator_offset"><ahref="#val-objc_iterator_offset"class="anchor"></a><code><spanclass="keyword">val</span> objc_iterator_offset : <ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a></code></dt><dd><p>Field for ObjC's nscollection's iterator offset</p></dd></dl></section><section><header><h3id="field-domain-constructor"><ahref="#field-domain-constructor"class="anchor"></a>Field domain constructor</h3></header><dl><dtclass="spec type"id="type-field_typ"><ahref="#type-field_typ"class="anchor"></a><code><spanclass="keyword">type</span> field_typ</code><code> = <span><ahref="../../IR/Typ/index.html#type-t">IR.Typ.t</a> option</span></code></dt><dtclass="spec type"id="type-t"><ahref="#type-t"class="anchor"></a><code><spanclass="keyword">type</span><span>'prim t</span></code><code> = </code><tableclass="variant"><trid="type-t.Prim"class="anchored"><tdclass="def constructor"><ahref="#type-t.Prim"class="anchor"></a><code>| </code><code><spanclass="constructor">Prim</span><spanclass="keyword">of</span><spanclass="type-var">'prim</span></code></td></tr><trid="type-t.Field"class="anchored"><tdclass="def constructor"><ahref="#type-t.Field"class="anchor"></a><code>| </code><code><spanclass="constructor">Field</span><spanclass="keyword">of</span></code><code>{</code><tableclass="record"><trid="type-t.prefix"class="anchored"><tdclass="def field"><ahref="#type-t.prefix"class="anchor"></a><code>prefix : <span><spanclass="type-var">'prim</span><ahref="index.html#type-t">t</a></span>;</code></td></tr><trid="type-t.fn"class="anchored"><tdclass="def field"><ahref="#type-t.fn"class="anchor"></a><code>fn : <ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a>;</code></td></tr><trid="type-t.typ"class="anchored"><tdclass="def field"><ahref="#type-t.typ"class="anchor"></a><code>typ : <ahref="index.html#type-field_typ">field_typ</a>;</code></td></tr></table><code>}</code></td></tr><trid="type-t.StarField"class="anchored"><tdclass="def constructor"><ahref="#type-t.StarField"class="anchor"></a><code>| </code><code><spanclass="constructor">StarField</span><spanclass="keyword">of</span></code><code>{</code><tableclass="record"><trid="type-t.prefix"class="anchored"><tdclass="def field"><ahref="#type-t.prefix"class="anchor"></a><code>prefix : <span><spanclass="type-var">'prim</span><ahref="index.html#type-t">t</a></span>;</code></td></tr><trid="type-t.last_field"class="anchored"><tdclass="def field"><ahref="#type-t.last_field"class="anchor"></a><code>last_field : <ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a>;</code></td></tr></table><code>}</code></td><tdclass="doc"><p>Represents a path starting with <code>prefix</code> and ending with the field <code>last_field</code>, the middle can be anything. Invariants:</p><ul><li>There is at most one StarField</li><li>StarField excluded, there are no duplicate fieldnames</li><li>StarField can only be followed by Deref elements</li></ul></td></tr></table></dt></dl><div><divclass="spec include"><divclass="doc"><dl><dtclass="spec value"id="val-compare"><ahref="#val-compare"class="anchor"></a><code><spanclass="keyword">val</span> compare : <span>(<spanclass="type-var">'prim</span><span>-></span><spanclass="type-var">'prim</span><span>-></span> int)</span><span>-></span><span><spanclass="type-var">'prim</span><ahref="index.html#type-t">t</a></span><span>-></span><span><spanclass="type-var">'prim</span><ahref="index.html#type-t">t</a></span><span>-></span> int</code></dt></dl></div></div></div><dl><dtclass="spec value"id="val-mk_append_field"><ahref="#val-mk_append_field"class="anchor"></a><code><spanclass="keyword">val</span> mk_append_field : <span>prim_append_field:<span>(<span>?⁠typ:<ahref="../../IR/Typ/index.html#type-t">IR.Typ.t</a></span><span>-></span><span><spanclass="type-var">'prim</span><ahref="index.html#type-t">t</a></span><span>-></span><ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a><span>-></span><span>(<span>depth:int</span><span>-></span><span><spanclass="type-var">'prim</span><ahref="index.html#type-t">t</a></span><span>-></span><span><spanclass="type-var">'prim</span><ahref="index.html#type-t">t</a></span>)</span><span>-></span> int <span>-></span><spanclass="type-var">'prim</span><span>-></span><span><spanclass="type-var">'prim</span><ahref="index.html#type-t">t</a></span>)</span></span><span>-></span><span>prim_append_star_field:<span>(<span><spanclass="type-var">'prim</span><ahref="index.html#type-t">t</a></span><span>-></span><ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a><span>-></span><span>(<span><spanclass="type-var">'prim</span><ahref="index.html#type-t">t</a></span><span>-></span><span><spanclass="type-var">'prim</span><ahref="index.html#type-t">t</a></span>)</span><span>-></span><spanclass="type-var">'prim</span><span>-></span><span><spanclass="type-var">'prim</span><ahref="index.html#type-t">t</a></span>)</span></span><span>-></span><span>?⁠typ:<ahref="../../IR/Typ/index.html#type-t">IR.Typ.t</a></span><span>-></span><span><spanclass="type-var">'prim</span><ahref="index.html#type-t">t</a></span><span>-></span><ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a><span>-></span><span><spanclass="type-var">'prim</span><ahref="index.html#type-t">t</a></span></code></dt><dtclass="spec value"id="val-mk_append_star_field"><ahref="#val-mk_append_star_field"class="anchor"></a><code><spanclass="keyword">val</span> mk_append_star_field : <span>prim_append_star_field:<span>(<span><spanclass="type-var">'prim</span><ahref="index.html#type-t">t</a></span><span>-></span><ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a><span>-></span><span>(<span><spanclass="type-var">'prim</span><ahref="index.html#type-t">t</a></span><span>-></span><span><spanclass="type-var">'prim</span><ahref="index.html#type-t">t</a></span>)</span><span>-></span><spanclass="type-var">'prim</span><span>-></span><span><spanclass="type-var">'prim</span><ahref="index.html#type-t">t</a></span>)</span></span><span>-></span><span><spanclass="type-var">'prim</span><ahref="index.html#type-t">t</a></span><span>-></span><ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a><span>-></span><span><spanclass="type-var">'prim</span><ahref="index.html#type-t">t</a></span></code></dt></dl></section></div></body></html>
