<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Rumai::IXP::Struct::Field</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" href="../../../../css/reset.css" type="text/css" media="screen" />
<link rel="stylesheet" href="../../../../css/main.css" type="text/css" media="screen" />
<script src="../../../../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
<script src="../../../../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
<script src="../../../../js/main.js" type="text/javascript" charset="utf-8"></script>
</head>
<body>
<div class="banner">
<h1>
<span class="type">Class</span>
Rumai::IXP::Struct::Field
<span class="parent"><
<a href="../../../Object.html">Object</a>
</span>
</h1>
<ul class="files">
<li><a href="../../../../files/lib/rumai/ixp/message_rb.html">lib/rumai/ixp/message.rb</a></li>
</ul>
</div>
<div id="bodyContent">
<div id="content">
<div class="description">
<p>
A field inside a <a href="../Struct.html">Struct</a>.
</p>
<p>
A field’s value is considered to be either:
</p>
<ul>
<li>array of format when <tt>counter && format.is_a? Class</tt>
</li>
<li>raw byte string when <tt>counter && format.nil?</tt>
</li>
</ul>
</div>
<div class="sectiontitle">Methods</div>
<dl class="methods">
<dt>C</dt>
<dd>
<ul>
<li><a href="#M000153">countee=</a>,</li>
<li><a href="#M000152">counter=</a></li>
</ul>
</dd>
<dt>F</dt>
<dd>
<ul>
<li><a href="#M000154">factory</a></li>
</ul>
</dd>
<dt>L</dt>
<dd>
<ul>
<li><a href="#M000156">load_9p</a></li>
</ul>
</dd>
<dt>N</dt>
<dd>
<ul>
<li><a href="#M000148">new</a></li>
</ul>
</dd>
<dt>T</dt>
<dd>
<ul>
<li><a href="#M000155">to_9p</a></li>
</ul>
</dd>
</dl>
<div class="sectiontitle">Classes and Modules</div>
<ul>
<li><span class="type">MODULE</span> <a href="Field/CounteeField.html">Rumai::IXP::Struct::Field::CounteeField</a></li>
<li><span class="type">MODULE</span> <a href="Field/CounterField.html">Rumai::IXP::Struct::Field::CounterField</a></li>
</ul>
<div class="sectiontitle">Attributes</div>
<table border='0' cellpadding='5'>
<tr valign='top'>
<td class='attr-rw'>
[R]
</td>
<td class='attr-name'>name</td>
<td class='attr-desc'></td>
</tr>
<tr valign='top'>
<td class='attr-rw'>
[R]
</td>
<td class='attr-name'>format</td>
<td class='attr-desc'></td>
</tr>
<tr valign='top'>
<td class='attr-rw'>
[R]
</td>
<td class='attr-name'>counter</td>
<td class='attr-desc'></td>
</tr>
<tr valign='top'>
<td class='attr-rw'>
[R]
</td>
<td class='attr-name'>countee</td>
<td class='attr-desc'></td>
</tr>
</table>
<div class="sectiontitle">Class Public methods</div>
<div class="method">
<div class="title" id="M000154">
<a name="M000154"></a><b>factory</b>(format)
</div>
<div class="description">
<p>
Returns a <a href="Field.html">Field</a> class that best represents the
given format.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000154_source')" id="l_M000154_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/5fcf09b89976a53dd9346e335a1803b337e0c447/lib/rumai/ixp/message.rb#L187" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000154_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/ixp/message.rb, line 187</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">factory</span> <span class="ruby-identifier">format</span>
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">format</span> <span class="ruby-operator">==</span> <span class="ruby-constant">String</span>
<span class="ruby-constant">StringField</span>
<span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">format</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Class</span>
<span class="ruby-constant">ClassField</span>
<span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">format</span> <span class="ruby-operator">==</span> <span class="ruby-value">8</span>
<span class="ruby-constant">Integer8Field</span>
<span class="ruby-keyword kw">else</span>
<span class="ruby-constant">Field</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000148">
<a name="M000148"></a><b>new</b>(name, format = nil, counter = nil)
</div>
<div class="description">
<dl>
<dt>name</dt><dd>unique (among all fields in a struct) name for the field
</dd>
<dt>format</dt><dd>number of bytes, a class, or nil
</dd>
<dt>counter</dt><dd>field which counts the length of this field’s value
</dd>
</dl>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000148_source')" id="l_M000148_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/5fcf09b89976a53dd9346e335a1803b337e0c447/lib/rumai/ixp/message.rb#L156" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000148_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/ixp/message.rb, line 156</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span> <span class="ruby-identifier">name</span>, <span class="ruby-identifier">format</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">counter</span> = <span class="ruby-keyword kw">nil</span>
<span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
<span class="ruby-ivar">@format</span> = <span class="ruby-identifier">format</span>
<span class="ruby-ivar">@countee</span> = <span class="ruby-keyword kw">nil</span>
<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">counter</span> = <span class="ruby-identifier">counter</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="sectiontitle">Instance Public methods</div>
<div class="method">
<div class="title" id="M000153">
<a name="M000153"></a><b>countee=</b>(field)
</div>
<div class="description">
<p>
Sets the countee for this field (implying that this field counts the length
of the given field).
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000153_source')" id="l_M000153_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/5fcf09b89976a53dd9346e335a1803b337e0c447/lib/rumai/ixp/message.rb#L178" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000153_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/ixp/message.rb, line 178</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">countee=</span> <span class="ruby-identifier">field</span>
<span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@countee</span> = <span class="ruby-identifier">field</span>
<span class="ruby-identifier">extend</span> <span class="ruby-constant">CounterField</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000152">
<a name="M000152"></a><b>counter=</b>(field)
</div>
<div class="description">
<p>
Sets the counter for this field (implying that the length of this field is
counted by the given field).
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000152_source')" id="l_M000152_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/5fcf09b89976a53dd9346e335a1803b337e0c447/lib/rumai/ixp/message.rb#L167" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000152_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/ixp/message.rb, line 167</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">counter=</span> <span class="ruby-identifier">field</span>
<span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@counter</span> = <span class="ruby-identifier">field</span>
<span class="ruby-identifier">extend</span> <span class="ruby-constant">CounteeField</span>
<span class="ruby-ivar">@counter</span>.<span class="ruby-identifier">countee</span> = <span class="ruby-keyword kw">self</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000156">
<a name="M000156"></a><b>load_9p</b>(stream, field_values)
</div>
<div class="description">
<p>
Populates this object with information taken from the given 9P2000 byte
stream.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000156_source')" id="l_M000156_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/5fcf09b89976a53dd9346e335a1803b337e0c447/lib/rumai/ixp/message.rb#L213" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000156_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/ixp/message.rb, line 213</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">load_9p</span> <span class="ruby-identifier">stream</span>, <span class="ruby-identifier">field_values</span>
<span class="ruby-identifier">field_values</span>[<span class="ruby-ivar">@name</span>] = <span class="ruby-identifier">value_from_9p</span> <span class="ruby-identifier">stream</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
<div class="method">
<div class="title" id="M000155">
<a name="M000155"></a><b>to_9p</b>(field_values)
</div>
<div class="description">
<p>
Transforms this object into a string of 9P2000 bytes.
</p>
</div>
<div class="sourcecode">
<p class="source-link">
Source: <a href="javascript:toggleSource('M000155_source')" id="l_M000155_source">show</a>
| <a href="http://github.com/sunaku/rumai/blob/5fcf09b89976a53dd9346e335a1803b337e0c447/lib/rumai/ixp/message.rb#L205" target="_blank" class="github_url">on GitHub</a>
</p>
<div id="M000155_source" class="dyn-source">
<pre><span class="ruby-comment cmt"># File lib/rumai/ixp/message.rb, line 205</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_9p</span> <span class="ruby-identifier">field_values</span>
<span class="ruby-identifier">value_to_9p</span> <span class="ruby-identifier">field_values</span>[<span class="ruby-ivar">@name</span>]
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
</div>
</div>
</body>
</html>