<!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_write_c.html">
<link rel="next" href="Size.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_read_c</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Unsafe_write_c.html" title="Unsafe_write_c">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="Size.html" title="Size">Next</a>
</div>
<h1>Module <a href="type_Unsafe_read_c.html">Unsafe_read_c</a></h1>
<pre><span class="keyword">module</span> Unsafe_read_c: <code class="code">sig</code> <a href="Unsafe_read_c.html">..</a> <code class="code">end</code></pre><div class="info module top">
Reading values from the binary protocol using unsafe C.<br>
</div>
<hr width="100%">
<pre><span id="EXCEPTIONError"><span class="keyword">exception</span> Error</span> <span class="keyword">of</span> <code class="type"><a href="Common.ReadError.html#TYPEt">Common.ReadError.t</a></code></pre>
<pre><span id="VALraise_variant_wrong_type"><span class="keyword">val</span> raise_variant_wrong_type</span> : <code class="type">string -> 'a</code></pre><div class="info ">
<code class="code">raise_variant_wrong_type type_name</code><br>
<b>Raises</b> <code>Error</code> (Common.ReadError.VariantWrongType type_name).<br>
</div>
<pre><span id="TYPEreader"><span class="keyword">type</span> <code class="type">'a</code> reader</span> = <code class="type"><a href="Unsafe_common.html#TYPEsptr_ptr">Unsafe_common.sptr_ptr</a> -> <a href="Unsafe_common.html#TYPEeptr">Unsafe_common.eptr</a> -> 'a</code> </pre>
<div class="info ">
Type of unsafe reader functions for the binary protocol. They take a
pointer to a source pointer to start reading and an end pointer
designating the end of the buffer, and return the unmarshalled value.
The pointer to the next buffer position after reading in the value
will be stored in the pointer to the source pointer.<br>
</div>
<pre><span id="TYPEreader1"><span class="keyword">type</span> <code class="type">('a, 'b)</code> reader1</span> = <code class="type">'a <a href="Unsafe_read_c.html#TYPEreader">reader</a> -> 'b <a href="Unsafe_read_c.html#TYPEreader">reader</a></code> </pre>
<pre><span id="TYPEreader2"><span class="keyword">type</span> <code class="type">('a, 'b, 'c)</code> reader2</span> = <code class="type">'a <a href="Unsafe_read_c.html#TYPEreader">reader</a> -> ('b, 'c) <a href="Unsafe_read_c.html#TYPEreader1">reader1</a></code> </pre>
<pre><span id="TYPEreader3"><span class="keyword">type</span> <code class="type">('a, 'b, 'c, 'd)</code> reader3</span> = <code class="type">'a <a href="Unsafe_read_c.html#TYPEreader">reader</a> -> ('b, 'c, 'd) <a href="Unsafe_read_c.html#TYPEreader2">reader2</a></code> </pre>
<pre><span id="VALbin_read_unit"><span class="keyword">val</span> bin_read_unit</span> : <code class="type">unit <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_bool"><span class="keyword">val</span> bin_read_bool</span> : <code class="type">bool <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_string"><span class="keyword">val</span> bin_read_string</span> : <code class="type">string <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_char"><span class="keyword">val</span> bin_read_char</span> : <code class="type">char <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_int"><span class="keyword">val</span> bin_read_int</span> : <code class="type">int <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_float"><span class="keyword">val</span> bin_read_float</span> : <code class="type">float <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_int32"><span class="keyword">val</span> bin_read_int32</span> : <code class="type">int32 <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_int64"><span class="keyword">val</span> bin_read_int64</span> : <code class="type">int64 <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_nativeint"><span class="keyword">val</span> bin_read_nativeint</span> : <code class="type">nativeint <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_nat0"><span class="keyword">val</span> bin_read_nat0</span> : <code class="type"><a href="Nat0.html#TYPEt">Nat0.t</a> <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_ref"><span class="keyword">val</span> bin_read_ref</span> : <code class="type">('a, 'a Pervasives.ref) <a href="Unsafe_read_c.html#TYPEreader1">reader1</a></code></pre>
<pre><span id="VALbin_read_lazy"><span class="keyword">val</span> bin_read_lazy</span> : <code class="type">('a, 'a lazy_t) <a href="Unsafe_read_c.html#TYPEreader1">reader1</a></code></pre>
<pre><span id="VALbin_read_option"><span class="keyword">val</span> bin_read_option</span> : <code class="type">('a, 'a option) <a href="Unsafe_read_c.html#TYPEreader1">reader1</a></code></pre>
<pre><span id="VALbin_read_pair"><span class="keyword">val</span> bin_read_pair</span> : <code class="type">('a, 'b, 'a * 'b) <a href="Unsafe_read_c.html#TYPEreader2">reader2</a></code></pre>
<pre><span id="VALbin_read_triple"><span class="keyword">val</span> bin_read_triple</span> : <code class="type">('a, 'b, 'c, 'a * 'b * 'c) <a href="Unsafe_read_c.html#TYPEreader3">reader3</a></code></pre>
<pre><span id="VALbin_read_list"><span class="keyword">val</span> bin_read_list</span> : <code class="type">('a, 'a list) <a href="Unsafe_read_c.html#TYPEreader1">reader1</a></code></pre>
<pre><span id="VALbin_read_array"><span class="keyword">val</span> bin_read_array</span> : <code class="type">('a, 'a array) <a href="Unsafe_read_c.html#TYPEreader1">reader1</a></code></pre>
<pre><span id="VALbin_read_hashtbl"><span class="keyword">val</span> bin_read_hashtbl</span> : <code class="type">('a, 'b, ('a, 'b) Hashtbl.t) <a href="Unsafe_read_c.html#TYPEreader2">reader2</a></code></pre>
<pre><span id="VALbin_read_float32_vec"><span class="keyword">val</span> bin_read_float32_vec</span> : <code class="type"><a href="Common.html#TYPEvec32">Common.vec32</a> <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_float64_vec"><span class="keyword">val</span> bin_read_float64_vec</span> : <code class="type"><a href="Common.html#TYPEvec64">Common.vec64</a> <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_vec"><span class="keyword">val</span> bin_read_vec</span> : <code class="type"><a href="Common.html#TYPEvec">Common.vec</a> <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_float32_mat"><span class="keyword">val</span> bin_read_float32_mat</span> : <code class="type"><a href="Common.html#TYPEmat32">Common.mat32</a> <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_float64_mat"><span class="keyword">val</span> bin_read_float64_mat</span> : <code class="type"><a href="Common.html#TYPEmat64">Common.mat64</a> <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_mat"><span class="keyword">val</span> bin_read_mat</span> : <code class="type"><a href="Common.html#TYPEmat">Common.mat</a> <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_bigstring"><span class="keyword">val</span> bin_read_bigstring</span> : <code class="type"><a href="Common.html#TYPEbuf">Common.buf</a> <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_float_array"><span class="keyword">val</span> bin_read_float_array</span> : <code class="type">float array <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_variant_int"><span class="keyword">val</span> bin_read_variant_int</span> : <code class="type">int <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_variant_tag"><span class="keyword">val</span> bin_read_variant_tag</span> : <code class="type">[> ] <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_raw_string"><span class="keyword">val</span> bin_read_raw_string</span> : <code class="type">(string -> pos:int -> len:int -> unit) <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_int_8bit"><span class="keyword">val</span> bin_read_int_8bit</span> : <code class="type">int <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_int_16bit"><span class="keyword">val</span> bin_read_int_16bit</span> : <code class="type">int <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_int_32bit"><span class="keyword">val</span> bin_read_int_32bit</span> : <code class="type">int <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_int_64bit"><span class="keyword">val</span> bin_read_int_64bit</span> : <code class="type">int <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_int64_bits"><span class="keyword">val</span> bin_read_int64_bits</span> : <code class="type">int64 <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_network16_int"><span class="keyword">val</span> bin_read_network16_int</span> : <code class="type">int <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_network32_int"><span class="keyword">val</span> bin_read_network32_int</span> : <code class="type">int <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_network32_int32"><span class="keyword">val</span> bin_read_network32_int32</span> : <code class="type">int32 <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_network64_int"><span class="keyword">val</span> bin_read_network64_int</span> : <code class="type">int <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre>
<pre><span id="VALbin_read_network64_int64"><span class="keyword">val</span> bin_read_network64_int64</span> : <code class="type">int64 <a href="Unsafe_read_c.html#TYPEreader">reader</a></code></pre></body></html>
