erlang/docs/ecapnp_val.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Module ecapnp_val</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
<body bgcolor="white">
<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<hr>

<h1>Module ecapnp_val</h1>
<ul class="index"><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>Cap'n Proto value support.
<p>Copyright © 2013, Andreas Stenius</p>

<p><b>Authors:</b> Andreas Stenius (<a href="mailto:[email protected]"><tt>[email protected]</tt></a>).</p>

<h2><a name="description">Description</a></h2><p>Cap'n Proto value support.</p>
 
  Everything value.
<h2><a name="types">Data Types</a></h2>

<h3 class="typedecl"><a name="type-value_type">value_type()</a></h3>
<p><tt>value_type() = <a href="ecapnp.html#type-value_type">ecapnp:value_type()</a></tt></p>


<h2><a name="index">Function Index</a></h2>
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#get-2">get/2</a></td><td>Decode data from Cap'n Proto format.</td></tr>
<tr><td valign="top"><a href="#get-3">get/3</a></td><td>Decode data from Cap'n Proto format.</td></tr>
<tr><td valign="top"><a href="#set-2">set/2</a></td><td>Encode value to Cap'n Proto format.</td></tr>
<tr><td valign="top"><a href="#set-3">set/3</a></td><td>Encode value to Cap'n Proto format.</td></tr>
<tr><td valign="top"><a href="#size-1">size/1</a></td><td>Get number of bits for <code>ValueType</code>.</td></tr>
</table>

<h2><a name="functions">Function Details</a></h2>

<h3 class="function"><a name="get-2">get/2</a></h3>
<div class="spec">
<p><tt>get(ValueType::<a href="#type-value_type">value_type()</a>, Data::binary()) -&gt; number() | boolean()</tt><br></p>
</div><p>Decode data from Cap'n Proto format.</p>

<h3 class="function"><a name="get-3">get/3</a></h3>
<div class="spec">
<p><tt>get(ValueType::<a href="#type-value_type">value_type()</a>, Data::binary(), Default::binary()) -&gt; number() | boolean()</tt><br></p>
</div><p><p>Decode data from Cap'n Proto format.</p>
 
  The <code>Data</code> is XOR'ed with <code>Default</code> prior to decoding.</p>

<h3 class="function"><a name="set-2">set/2</a></h3>
<div class="spec">
<p><tt>set(ValueType::<a href="#type-value_type">value_type()</a>, Value::number() | boolean()) -&gt; binary()</tt><br></p>
</div><p>Encode value to Cap'n Proto format.</p>

<h3 class="function"><a name="set-3">set/3</a></h3>
<div class="spec">
<p><tt>set(ValueType::<a href="#type-value_type">value_type()</a>, Value::number() | boolean(), Default::binary()) -&gt; binary()</tt><br></p>
</div><p><p>Encode value to Cap'n Proto format.</p>
 
  The result is XOR'ed with <code>Default</code>.</p>

<h3 class="function"><a name="size-1">size/1</a></h3>
<div class="spec">
<p><tt>size(ValueType::<a href="#type-value_type">value_type()</a>) -&gt; non_neg_integer()</tt><br></p>
</div><p>Get number of bits for <code>ValueType</code>.</p>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, May 30 2014, 12:56:29.</i></p>
</body>
</html>