erlang/docs/ecapnp_set.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_set</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_set</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>Write 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>Write support.</p>
 
  Everything for writing data into a message.
<h2><a name="types">Data Types</a></h2>

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


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


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


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


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


<h3 class="typedecl"><a name="type-type_name">type_name()</a></h3>
<p><tt>type_name() = <a href="ecapnp.html#type-type_name">ecapnp:type_name()</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="#field-2">field/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#field-3">field/3</a></td><td>Write field value to object.</td></tr>
<tr><td valign="top"><a href="#root-1">root/1</a></td><td>Get root object for a new message.</td></tr>
<tr><td valign="top"><a href="#root-2">root/2</a></td><td>Get root object for a new message.</td></tr>
<tr><td valign="top"><a href="#union-2">union/2</a></td><td>Write unnamed union value in object.</td></tr>
</table>

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

<h3 class="function"><a name="field-2">field/2</a></h3>
<div class="spec">
<p><tt>field(FieldName, Rpc_call) -&gt; any()</tt></p>
</div>

<h3 class="function"><a name="field-3">field/3</a></h3>
<div class="spec">
<p><tt>field(FieldName::<a href="#type-field_name">field_name()</a>, Value::<a href="#type-field_value">field_value()</a>, Rpc_call::<a href="#type-object">object()</a>) -&gt; ok | list()</tt><br></p>
</div><p>Write field value to object.</p>

<h3 class="function"><a name="root-1">root/1</a></h3>
<div class="spec">
<p><tt>root(Node::<a href="#type-schema_node">schema_node()</a>) -&gt; {ok, <a href="#type-object">object()</a>}</tt><br></p>
</div><p>Get root object for a new message.</p>

<h3 class="function"><a name="root-2">root/2</a></h3>
<div class="spec">
<p><tt>root(Type::<a href="#type-type_name">type_name()</a>, Schema::<a href="#type-schema">schema()</a>) -&gt; {ok, <a href="#type-object">object()</a>}</tt><br></p>
</div><p>Get root object for a new message.</p>

<h3 class="function"><a name="union-2">union/2</a></h3>
<div class="spec">
<p><tt>union(Value::{<a href="#type-field_name">field_name()</a>, <a href="#type-field_value">field_value()</a>} | <a href="#type-field_name">field_name()</a>, Rpc_call::<a href="#type-object">object()</a>) -&gt; ok</tt><br></p>
</div><p>Write unnamed union value in object.</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>