<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Unsafe_common.html">
<link rel="next" href="Unsafe_read_c.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Binable" rel="Chapter" href="Binable.html">
<link title="Nat0" rel="Chapter" href="Nat0.html">
<link title="Common" rel="Chapter" href="Common.html">
<link title="Unsafe_common" rel="Chapter" href="Unsafe_common.html">
<link title="Unsafe_write_c" rel="Chapter" href="Unsafe_write_c.html">
<link title="Unsafe_read_c" rel="Chapter" href="Unsafe_read_c.html">
<link title="Size" rel="Chapter" href="Size.html">
<link title="Write_ml" rel="Chapter" href="Write_ml.html">
<link title="Read_ml" rel="Chapter" href="Read_ml.html">
<link title="Write_c" rel="Chapter" href="Write_c.html">
<link title="Read_c" rel="Chapter" href="Read_c.html">
<link title="Std" rel="Chapter" href="Std.html">
<link title="Type_class" rel="Chapter" href="Type_class.html">
<link title="Map_to_safe" rel="Chapter" href="Map_to_safe.html">
<link title="Utils" rel="Chapter" href="Utils.html"><title>Unsafe_write_c</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Unsafe_common.html" title="Unsafe_common">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="Unsafe_read_c.html" title="Unsafe_read_c">Next</a>
</div>
<h1>Module <a href="type_Unsafe_write_c.html">Unsafe_write_c</a></h1>
<pre><span class="keyword">module</span> Unsafe_write_c: <code class="code">sig</code> <a href="Unsafe_write_c.html">..</a> <code class="code">end</code></pre><div class="info module top">
Writing values to the binary protocol using unsafe C.<br>
</div>
<hr width="100%">
<pre><span id="TYPEwriter"><span class="keyword">type</span> <code class="type">'a</code> writer</span> = <code class="type"><a href="Unsafe_common.html#TYPEsptr">Unsafe_common.sptr</a> -> <a href="Unsafe_common.html#TYPEeptr">Unsafe_common.eptr</a> -> 'a -> <a href="Unsafe_common.html#TYPEsptr">Unsafe_common.sptr</a></code> </pre>
<div class="info ">
Type of unsafe writer functions for the binary protocol. They take a
start pointer for writing, an end pointer designating the end of the
buffer and the value to be written, and return the start pointer to
the next write position.<br>
</div>
<pre><span id="TYPEwriter1"><span class="keyword">type</span> <code class="type">('a, 'b)</code> writer1</span> = <code class="type">'a <a href="Unsafe_write_c.html#TYPEwriter">writer</a> -> 'b <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code> </pre>
<pre><span id="TYPEwriter2"><span class="keyword">type</span> <code class="type">('a, 'b, 'c)</code> writer2</span> = <code class="type">'a <a href="Unsafe_write_c.html#TYPEwriter">writer</a> -> ('b, 'c) <a href="Unsafe_write_c.html#TYPEwriter1">writer1</a></code> </pre>
<pre><span id="TYPEwriter3"><span class="keyword">type</span> <code class="type">('a, 'b, 'c, 'd)</code> writer3</span> = <code class="type">'a <a href="Unsafe_write_c.html#TYPEwriter">writer</a> -> ('b, 'c, 'd) <a href="Unsafe_write_c.html#TYPEwriter2">writer2</a></code> </pre>
<pre><span id="VALbin_write_unit"><span class="keyword">val</span> bin_write_unit</span> : <code class="type">unit <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre>
<pre><span id="VALbin_write_bool"><span class="keyword">val</span> bin_write_bool</span> : <code class="type">bool <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre>
<pre><span id="VALbin_write_string"><span class="keyword">val</span> bin_write_string</span> : <code class="type">string <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre>
<pre><span id="VALbin_write_char"><span class="keyword">val</span> bin_write_char</span> : <code class="type">char <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre>
<pre><span id="VALbin_write_int"><span class="keyword">val</span> bin_write_int</span> : <code class="type">int <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre>
<pre><span id="VALbin_write_float"><span class="keyword">val</span> bin_write_float</span> : <code class="type">float <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre>
<pre><span id="VALbin_write_int32"><span class="keyword">val</span> bin_write_int32</span> : <code class="type">int32 <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre>
<pre><span id="VALbin_write_int64"><span class="keyword">val</span> bin_write_int64</span> : <code class="type">int64 <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre>
<pre><span id="VALbin_write_nativeint"><span class="keyword">val</span> bin_write_nativeint</span> : <code class="type">nativeint <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre>
<pre><span id="VALbin_write_nat0"><span class="keyword">val</span> bin_write_nat0</span> : <code class="type"><a href="Nat0.html#TYPEt">Nat0.t</a> <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre>
<pre><span id="VALbin_write_ref"><span class="keyword">val</span> bin_write_ref</span> : <code class="type">('a, 'a Pervasives.ref) <a href="Unsafe_write_c.html#TYPEwriter1">writer1</a></code></pre>
<pre><span id="VALbin_write_lazy"><span class="keyword">val</span> bin_write_lazy</span> : <code class="type">('a, 'a lazy_t) <a href="Unsafe_write_c.html#TYPEwriter1">writer1</a></code></pre>
<pre><span id="VALbin_write_option"><span class="keyword">val</span> bin_write_option</span> : <code class="type">('a, 'a option) <a href="Unsafe_write_c.html#TYPEwriter1">writer1</a></code></pre>
<pre><span id="VALbin_write_pair"><span class="keyword">val</span> bin_write_pair</span> : <code class="type">('a, 'b, 'a * 'b) <a href="Unsafe_write_c.html#TYPEwriter2">writer2</a></code></pre>
<pre><span id="VALbin_write_triple"><span class="keyword">val</span> bin_write_triple</span> : <code class="type">('a, 'b, 'c, 'a * 'b * 'c) <a href="Unsafe_write_c.html#TYPEwriter3">writer3</a></code></pre>
<pre><span id="VALbin_write_list"><span class="keyword">val</span> bin_write_list</span> : <code class="type">('a, 'a list) <a href="Unsafe_write_c.html#TYPEwriter1">writer1</a></code></pre>
<pre><span id="VALbin_write_array"><span class="keyword">val</span> bin_write_array</span> : <code class="type">('a, 'a array) <a href="Unsafe_write_c.html#TYPEwriter1">writer1</a></code></pre>
<pre><span id="VALbin_write_hashtbl"><span class="keyword">val</span> bin_write_hashtbl</span> : <code class="type">('a, 'b, ('a, 'b) Hashtbl.t) <a href="Unsafe_write_c.html#TYPEwriter2">writer2</a></code></pre>
<pre><span id="VALbin_write_float32_vec"><span class="keyword">val</span> bin_write_float32_vec</span> : <code class="type"><a href="Common.html#TYPEvec32">Common.vec32</a> <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre>
<pre><span id="VALbin_write_float64_vec"><span class="keyword">val</span> bin_write_float64_vec</span> : <code class="type"><a href="Common.html#TYPEvec64">Common.vec64</a> <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre>
<pre><span id="VALbin_write_vec"><span class="keyword">val</span> bin_write_vec</span> : <code class="type"><a href="Common.html#TYPEvec">Common.vec</a> <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre>
<pre><span id="VALbin_write_float32_mat"><span class="keyword">val</span> bin_write_float32_mat</span> : <code class="type"><a href="Common.html#TYPEmat32">Common.mat32</a> <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre>
<pre><span id="VALbin_write_float64_mat"><span class="keyword">val</span> bin_write_float64_mat</span> : <code class="type"><a href="Common.html#TYPEmat64">Common.mat64</a> <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre>
<pre><span id="VALbin_write_mat"><span class="keyword">val</span> bin_write_mat</span> : <code class="type"><a href="Common.html#TYPEmat">Common.mat</a> <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre>
<pre><span id="VALbin_write_bigstring"><span class="keyword">val</span> bin_write_bigstring</span> : <code class="type"><a href="Common.html#TYPEbuf">Common.buf</a> <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre>
<pre><span id="VALbin_write_float_array"><span class="keyword">val</span> bin_write_float_array</span> : <code class="type">float array <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre>
<pre><span id="VALbin_write_variant_tag"><span class="keyword">val</span> bin_write_variant_tag</span> : <code class="type">[> ] <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre><div class="info ">
<code class="code">bin_write_variant_tag</code> writes out the exact bit representation of
the variant tag of the given value (= 32 bits).<br>
</div>
<pre><span id="VALbin_write_raw_string"><span class="keyword">val</span> bin_write_raw_string</span> : <code class="type"><a href="Unsafe_common.html#TYPEsptr">Unsafe_common.sptr</a> -><br> <a href="Unsafe_common.html#TYPEeptr">Unsafe_common.eptr</a> -> string -> pos:int -> len:int -> <a href="Unsafe_common.html#TYPEsptr">Unsafe_common.sptr</a></code></pre>
<pre><span id="VALbin_write_int_8bit"><span class="keyword">val</span> bin_write_int_8bit</span> : <code class="type">int <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre><div class="info ">
<code class="code">bin_write_int_8bit</code> writes out the exact bit representation of
the given <code class="code">int</code> value using the lower 8 bits.<br>
</div>
<pre><span id="VALbin_write_int_16bit"><span class="keyword">val</span> bin_write_int_16bit</span> : <code class="type">int <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre><div class="info ">
<code class="code">bin_write_int_16bit</code> writes out the exact bit representation of
the given <code class="code">int</code> value using the lower 16 bits.<br>
</div>
<pre><span id="VALbin_write_int_32bit"><span class="keyword">val</span> bin_write_int_32bit</span> : <code class="type">int <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre><div class="info ">
<code class="code">bin_write_int_32bit</code> writes out the exact bit representation of
the given <code class="code">int</code> value using the lower 32 bits.<br>
</div>
<pre><span id="VALbin_write_int_64bit"><span class="keyword">val</span> bin_write_int_64bit</span> : <code class="type">int <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre><div class="info ">
<code class="code">bin_write_int_64bit</code> writes out the exact bit representation of
the given <code class="code">int</code> value using all 64 bits.<br>
</div>
<pre><span id="VALbin_write_int64_bits"><span class="keyword">val</span> bin_write_int64_bits</span> : <code class="type">int64 <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre><div class="info ">
<code class="code">bin_write_int64_bits</code> writes out the exact bit representation of
the given <code class="code">int64</code> value.<br>
</div>
<pre><span id="VALbin_write_network16_int"><span class="keyword">val</span> bin_write_network16_int</span> : <code class="type">int <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre><div class="info ">
<code class="code">bin_write_network16_int</code> writes out an integer in 16bit network
byte order (= big-endian).<br>
</div>
<pre><span id="VALbin_write_network32_int"><span class="keyword">val</span> bin_write_network32_int</span> : <code class="type">int <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre><div class="info ">
<code class="code">bin_write_network32_int</code> writes out an integer in 32bit network
byte order (= big-endian).<br>
</div>
<pre><span id="VALbin_write_network32_int32"><span class="keyword">val</span> bin_write_network32_int32</span> : <code class="type">int32 <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre><div class="info ">
<code class="code">bin_write_network32_int32</code> writes out a 32bit integer in 32bit
network byte order (= big-endian).<br>
</div>
<pre><span id="VALbin_write_network64_int"><span class="keyword">val</span> bin_write_network64_int</span> : <code class="type">int <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre><div class="info ">
<code class="code">bin_write_network64_int</code> writes out an integer in 64bit network
byte order (= big-endian).<br>
</div>
<pre><span id="VALbin_write_network64_int64"><span class="keyword">val</span> bin_write_network64_int64</span> : <code class="type">int64 <a href="Unsafe_write_c.html#TYPEwriter">writer</a></code></pre><div class="info ">
<code class="code">bin_write_network64_int64</code> writes out a 64bit integer in 64bit
network byte order (= big-endian).<br>
</div>
<pre><span id="VALbin_write_array_no_length"><span class="keyword">val</span> bin_write_array_no_length</span> : <code class="type">('a, 'a array) <a href="Unsafe_write_c.html#TYPEwriter1">writer1</a></code></pre><div class="info ">
<code class="code">bin_write_array_no_length</code> writes out all values in the given array
without writing out its length.<br>
</div>
</body></html>
