RubyGems - rumai - Versions diffs - 2.0.2 → 2.1.0 - Mend

rumai 2.0.2 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (167) hide show

data/CREDITS +2 -0
data/bin/rumai +20 -8
data/doc/api/classes/IO.html +72 -0
data/doc/api/classes/Integer.html +110 -0
data/doc/api/classes/Object.html +60 -0
data/doc/api/classes/Rumai.html +867 -0
data/doc/api/classes/Rumai/Area.html +836 -0
data/doc/api/classes/Rumai/Chain.html +197 -0
data/doc/api/classes/Rumai/Client.html +865 -0
data/doc/api/classes/Rumai/ClientContainer.html +191 -0
data/doc/api/classes/Rumai/ExportInstanceMethods.html +69 -0
data/doc/api/classes/Rumai/IXP.html +131 -0
data/doc/api/classes/Rumai/IXP/Agent.html +836 -0
data/doc/api/classes/Rumai/IXP/Agent/FidStream.html +456 -0
data/doc/api/classes/Rumai/IXP/Agent/MODES.html +108 -0
data/doc/api/classes/Rumai/IXP/Agent/RangedPool.html +241 -0
data/doc/api/classes/Rumai/IXP/Error.html +67 -0
data/doc/api/classes/Rumai/IXP/Fcall.html +323 -0
data/doc/api/classes/Rumai/IXP/Qid.html +153 -0
data/doc/api/classes/Rumai/IXP/Rattach.html +67 -0
data/doc/api/classes/Rumai/IXP/Rauth.html +67 -0
data/doc/api/classes/Rumai/IXP/Rclunk.html +67 -0
data/doc/api/classes/Rumai/IXP/Rcreate.html +67 -0
data/doc/api/classes/Rumai/IXP/Rerror.html +67 -0
data/doc/api/classes/Rumai/IXP/Rflush.html +67 -0
data/doc/api/classes/Rumai/IXP/Ropen.html +67 -0
data/doc/api/classes/Rumai/IXP/Rread.html +67 -0
data/doc/api/classes/Rumai/IXP/Rremove.html +67 -0
data/doc/api/classes/Rumai/IXP/Rstat.html +67 -0
data/doc/api/classes/Rumai/IXP/Rversion.html +67 -0
data/doc/api/classes/Rumai/IXP/Rwalk.html +67 -0
data/doc/api/classes/Rumai/IXP/Rwrite.html +67 -0
data/doc/api/classes/Rumai/IXP/Rwstat.html +67 -0
data/doc/api/classes/Rumai/IXP/Stat.html +252 -0
data/doc/api/classes/Rumai/IXP/Stream.html +131 -0
data/doc/api/classes/Rumai/IXP/Struct.html +315 -0
data/doc/api/classes/Rumai/IXP/Struct/Field.html +415 -0
data/doc/api/classes/Rumai/IXP/Struct/Field/CounteeField.html +153 -0
data/doc/api/classes/Rumai/IXP/Struct/Field/CounterField.html +104 -0
data/doc/api/classes/Rumai/IXP/Tattach.html +68 -0
data/doc/api/classes/Rumai/IXP/Tauth.html +67 -0
data/doc/api/classes/Rumai/IXP/Tclunk.html +67 -0
data/doc/api/classes/Rumai/IXP/Tcreate.html +68 -0
data/doc/api/classes/Rumai/IXP/Terror.html +110 -0
data/doc/api/classes/Rumai/IXP/Tflush.html +67 -0
data/doc/api/classes/Rumai/IXP/Topen.html +165 -0
data/doc/api/classes/Rumai/IXP/Tread.html +67 -0
data/doc/api/classes/Rumai/IXP/Tremove.html +67 -0
data/doc/api/classes/Rumai/IXP/Tstat.html +67 -0
data/doc/api/classes/Rumai/IXP/Tversion.html +86 -0
data/doc/api/classes/Rumai/IXP/Twalk.html +68 -0
data/doc/api/classes/Rumai/IXP/Twrite.html +68 -0
data/doc/api/classes/Rumai/IXP/Twstat.html +67 -0
data/doc/api/classes/Rumai/Node.html +817 -0
data/doc/api/classes/Rumai/View.html +818 -0
data/doc/api/classes/Rumai/WidgetImpl.html +65 -0
data/doc/api/classes/Rumai/WidgetNode.html +68 -0
data/doc/api/classes/String.html +163 -0
data/doc/api/classes/StringIO.html +72 -0
data/doc/api/classes/Time.html +156 -0
data/doc/api/created.rid +1 -0
data/doc/api/css/main.css +263 -0
data/doc/api/css/panel.css +383 -0
data/doc/api/css/reset.css +53 -0
data/doc/api/files/CREDITS.html +64 -0
data/doc/api/files/LICENSE.html +76 -0
data/doc/api/files/lib/rumai/fs_rb.html +75 -0
data/doc/api/files/lib/rumai/ixp/message_rb.html +91 -0
data/doc/api/files/lib/rumai/ixp/transport_rb.html +75 -0
data/doc/api/files/lib/rumai/ixp_rb.html +69 -0
data/doc/api/files/lib/rumai/wm_rb.html +77 -0
data/doc/api/files/lib/rumai_rb.html +65 -0
data/doc/api/i/arrows.png +0 -0
data/doc/api/i/results_bg.png +0 -0
data/doc/api/i/tree_bg.png +0 -0
data/doc/api/index.html +14 -18
data/doc/api/js/jquery-1.3.2.min.js +19 -0
data/doc/api/js/jquery-effect.js +593 -0
data/doc/api/js/main.js +22 -0
data/doc/api/js/searchdoc.js +605 -0
data/doc/api/panel/index.html +63 -0
data/doc/api/panel/search_index.js +1 -0
data/doc/api/panel/tree.js +1 -0
data/doc/history.erb +41 -16
data/doc/index.erb +14 -11
data/doc/index.xhtml +519 -846
data/doc/intro.erb +33 -32
data/doc/setup.erb +14 -13
data/doc/usage.erb +69 -35
data/lib/rumai.rb +13 -5
data/lib/rumai/fs.rb +71 -27
data/lib/rumai/ixp.rb +4 -0
data/lib/rumai/ixp/message.rb +178 -81
data/lib/rumai/ixp/transport.rb +144 -91
data/lib/rumai/wm.rb +717 -593
data/rakefile +14 -0
data/test/rumai/ixp/message.rb +42 -54
metadata +110 -89
data/Rakefile +0 -8
data/doc/api/IO.html +0 -53
data/doc/api/Integer.html +0 -102
data/doc/api/Object.html +0 -23
data/doc/api/Rumai.html +0 -1218
data/doc/api/Rumai/Area.html +0 -1088
data/doc/api/Rumai/Chain.html +0 -230
data/doc/api/Rumai/Client.html +0 -1264
data/doc/api/Rumai/ClientContainer.html +0 -227
data/doc/api/Rumai/ExportInstMethods.html +0 -115
data/doc/api/Rumai/IXP.html +0 -23
data/doc/api/Rumai/IXP/Agent.html +0 -1222
data/doc/api/Rumai/IXP/Agent/FidStream.html +0 -602
data/doc/api/Rumai/IXP/Agent/RangedPool.html +0 -263
data/doc/api/Rumai/IXP/Error.html +0 -32
data/doc/api/Rumai/IXP/Fcall.html +0 -398
data/doc/api/Rumai/IXP/Qid.html +0 -99
data/doc/api/Rumai/IXP/Rattach.html +0 -71
data/doc/api/Rumai/IXP/Rauth.html +0 -71
data/doc/api/Rumai/IXP/Rclunk.html +0 -71
data/doc/api/Rumai/IXP/Rcreate.html +0 -71
data/doc/api/Rumai/IXP/Rerror.html +0 -71
data/doc/api/Rumai/IXP/Rflush.html +0 -71
data/doc/api/Rumai/IXP/Ropen.html +0 -71
data/doc/api/Rumai/IXP/Rread.html +0 -71
data/doc/api/Rumai/IXP/Rremove.html +0 -71
data/doc/api/Rumai/IXP/Rstat.html +0 -71
data/doc/api/Rumai/IXP/Rversion.html +0 -71
data/doc/api/Rumai/IXP/Rwalk.html +0 -71
data/doc/api/Rumai/IXP/Rwrite.html +0 -71
data/doc/api/Rumai/IXP/Rwstat.html +0 -71
data/doc/api/Rumai/IXP/Stat.html +0 -188
data/doc/api/Rumai/IXP/Stream.html +0 -112
data/doc/api/Rumai/IXP/Struct.html +0 -348
data/doc/api/Rumai/IXP/Struct/ClassField.html +0 -177
data/doc/api/Rumai/IXP/Struct/Field.html +0 -549
data/doc/api/Rumai/IXP/Struct/Field/CounteeField.html +0 -175
data/doc/api/Rumai/IXP/Struct/Field/CounterField.html +0 -95
data/doc/api/Rumai/IXP/Struct/Integer8Field.html +0 -181
data/doc/api/Rumai/IXP/Struct/StringField.html +0 -128
data/doc/api/Rumai/IXP/Tattach.html +0 -71
data/doc/api/Rumai/IXP/Tauth.html +0 -71
data/doc/api/Rumai/IXP/Tclunk.html +0 -71
data/doc/api/Rumai/IXP/Tcreate.html +0 -71
data/doc/api/Rumai/IXP/Terror.html +0 -156
data/doc/api/Rumai/IXP/Tflush.html +0 -71
data/doc/api/Rumai/IXP/Topen.html +0 -113
data/doc/api/Rumai/IXP/Tread.html +0 -71
data/doc/api/Rumai/IXP/Tremove.html +0 -71
data/doc/api/Rumai/IXP/Tstat.html +0 -71
data/doc/api/Rumai/IXP/Tversion.html +0 -83
data/doc/api/Rumai/IXP/Twalk.html +0 -71
data/doc/api/Rumai/IXP/Twrite.html +0 -71
data/doc/api/Rumai/IXP/Twstat.html +0 -71
data/doc/api/Rumai/Node.html +0 -1139
data/doc/api/Rumai/View.html +0 -1280
data/doc/api/Rumai/WidgetImpl.html +0 -196
data/doc/api/Rumai/WidgetNode.html +0 -184
data/doc/api/String.html +0 -180
data/doc/api/StringIO.html +0 -53
data/doc/api/Time.html +0 -175
data/doc/api/all-methods.html +0 -1436
data/doc/api/all-namespaces.html +0 -140
data/doc/api/app.js +0 -18
data/doc/api/jquery.js +0 -11
data/doc/api/readme.html +0 -38
data/doc/api/style.css +0 -68
data/doc/api/syntax_highlight.css +0 -21
data/doc/theory.erb +0 -3

data/doc/api/classes/Rumai/IXP/Struct.html ADDED

@@ -0,0 +1,315 @@
+<?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</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">Module</span>
+            Rumai::IXP::Struct
+        </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 serializable 9P2000 data structure.
+</p>
+    </div>
+    <div class="sectiontitle">Methods</div>
+    <dl class="methods">
+        <dt>I</dt>
+        <dd>
+            <ul>
+                <li><a href="#M000132">included</a></li>
+            </ul>
+        </dd>
+        <dt>L</dt>
+        <dd>
+            <ul>
+                <li><a href="#M000131">load_9p</a></li>
+            </ul>
+        </dd>
+        <dt>N</dt>
+        <dd>
+            <ul>
+                <li><a href="#M000129">new</a></li>
+            </ul>
+        </dd>
+        <dt>T</dt>
+        <dd>
+            <ul>
+                <li><a href="#M000130">to_9p</a></li>
+            </ul>
+        </dd>
+    </dl>
+    <div class="sectiontitle">Classes and Modules</div>
+    <ul>
+        <li><span class="type">CLASS</span> <a href="Struct/Field.html">Rumai::IXP::Struct::Field</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'>fields</td>
+            <td class='attr-desc'></td>
+        </tr>
+    </table>
+            <div class="sectiontitle">Class Public methods</div>
+            <div class="method">
+                <div class="title" id="M000132">
+                    <a name="M000132"></a><b>included</b>(target)
+                </div>
+                <div class="description">
+                  <p>
+Provides a convenient DSL (for defining fields) to all objects which
+<b>include</b> this module.
+</p>
+                </div>
+                <div class="sourcecode">
+                    <p class="source-link">
+                        Source: <a href="javascript:toggleSource('M000132_source')" id="l_M000132_source">show</a>
+                        | <a href="http://github.com/sunaku/rumai/blob/5fcf09b89976a53dd9346e335a1803b337e0c447/lib/rumai/ixp/message.rb#L86" target="_blank" class="github_url">on GitHub</a>
+                    </p>
+                    <div id="M000132_source" class="dyn-source">
+                        <pre><span class="ruby-comment cmt"># File lib/rumai/ixp/message.rb, line 86</span>
+      <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">included</span> <span class="ruby-identifier">target</span>
+        <span class="ruby-keyword kw">class</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">target</span>
+          <span class="ruby-comment cmt"># Returns a list of fields which compose this Struct.</span>
+          <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fields</span>
+            <span class="ruby-ivar">@fields</span> <span class="ruby-operator">||=</span>
+              <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">superclass</span>.<span class="ruby-identifier">respond_to?</span> <span class="ruby-identifier">:fields</span>
+                <span class="ruby-identifier">superclass</span>.<span class="ruby-identifier">fields</span>.<span class="ruby-identifier">dup</span>
+              <span class="ruby-keyword kw">else</span>
+                []
+              <span class="ruby-keyword kw">end</span>
+          <span class="ruby-keyword kw">end</span>
+          <span class="ruby-comment cmt">##</span>
+          <span class="ruby-comment cmt"># Defines a new field in this Struct.</span>
+          <span class="ruby-comment cmt">#</span>
+          <span class="ruby-comment cmt"># [args] arguments for Field.new()</span>
+          <span class="ruby-comment cmt">#</span>
+          <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">field</span> <span class="ruby-identifier">name</span>, <span class="ruby-identifier">format</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>
+            <span class="ruby-identifier">c</span> = <span class="ruby-constant">Field</span>.<span class="ruby-identifier">factory</span>(<span class="ruby-identifier">format</span>)
+            <span class="ruby-identifier">f</span> = <span class="ruby-identifier">c</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>, <span class="ruby-identifier">format</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
+            <span class="ruby-identifier">fields</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">f</span> <span class="ruby-comment cmt"># register field as being part of this structure</span>
+            <span class="ruby-comment cmt"># provide accessor methods to field values</span>
+            <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class_eval</span> <span class="ruby-node">%{
+              def #{f.name}
+                @values[#{f.name.inspect}]
+              end
+              def #{f.name}= value
+                @values[#{f.name.inspect}] = value
+              end
+            }</span>
+            <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">f</span>
+          <span class="ruby-keyword kw">end</span>
+          <span class="ruby-comment cmt">##</span>
+          <span class="ruby-comment cmt"># Creates a new instance of this class from the</span>
+          <span class="ruby-comment cmt"># given 9P2000 byte stream and returns the instance.</span>
+          <span class="ruby-comment cmt">#</span>
+          <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">from_9p</span> <span class="ruby-identifier">stream</span>, <span class="ruby-identifier">msg_class</span> = <span class="ruby-keyword kw">self</span>
+            <span class="ruby-identifier">msg</span> = <span class="ruby-identifier">msg_class</span>.<span class="ruby-identifier">new</span>
+            <span class="ruby-identifier">msg</span>.<span class="ruby-identifier">load_9p</span>(<span class="ruby-identifier">stream</span>)
+            <span class="ruby-identifier">msg</span>
+          <span class="ruby-keyword kw">end</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="M000129">
+                    <a name="M000129"></a><b>new</b>(field_values = {})
+                </div>
+                <div class="description">
+                  <p>
+Allows field values to be initialized via the constructor.
+</p>
+<dl>
+<dt>field_values</dt><dd>a mapping from field name to field value
+</dd>
+</dl>
+                </div>
+                <div class="sourcecode">
+                    <p class="source-link">
+                        Source: <a href="javascript:toggleSource('M000129_source')" id="l_M000129_source">show</a>
+                        | <a href="http://github.com/sunaku/rumai/blob/5fcf09b89976a53dd9346e335a1803b337e0c447/lib/rumai/ixp/message.rb#L60" target="_blank" class="github_url">on GitHub</a>
+                    </p>
+                    <div id="M000129_source" class="dyn-source">
+                        <pre><span class="ruby-comment cmt"># File lib/rumai/ixp/message.rb, line 60</span>
+      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span> <span class="ruby-identifier">field_values</span> = {}
+        <span class="ruby-ivar">@fields</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">fields</span>
+        <span class="ruby-ivar">@values</span> = <span class="ruby-identifier">field_values</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="M000131">
+                    <a name="M000131"></a><b>load_9p</b>(stream)
+                </div>
+                <div class="description">
+                  <p>
+Populates this object with information from the given 9P2000 byte stream.
+</p>
+                </div>
+                <div class="sourcecode">
+                    <p class="source-link">
+                        Source: <a href="javascript:toggleSource('M000131_source')" id="l_M000131_source">show</a>
+                        | <a href="http://github.com/sunaku/rumai/blob/5fcf09b89976a53dd9346e335a1803b337e0c447/lib/rumai/ixp/message.rb#L76" target="_blank" class="github_url">on GitHub</a>
+                    </p>
+                    <div id="M000131_source" class="dyn-source">
+                        <pre><span class="ruby-comment cmt"># File lib/rumai/ixp/message.rb, line 76</span>
+      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">load_9p</span> <span class="ruby-identifier">stream</span>
+        <span class="ruby-ivar">@fields</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
+          <span class="ruby-identifier">f</span>.<span class="ruby-identifier">load_9p</span> <span class="ruby-identifier">stream</span>, <span class="ruby-ivar">@values</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="M000130">
+                    <a name="M000130"></a><b>to_9p</b>()
+                </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('M000130_source')" id="l_M000130_source">show</a>
+                        | <a href="http://github.com/sunaku/rumai/blob/5fcf09b89976a53dd9346e335a1803b337e0c447/lib/rumai/ixp/message.rb#L68" target="_blank" class="github_url">on GitHub</a>
+                    </p>
+                    <div id="M000130_source" class="dyn-source">
+                        <pre><span class="ruby-comment cmt"># File lib/rumai/ixp/message.rb, line 68</span>
+      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_9p</span>
+        <span class="ruby-ivar">@fields</span>.<span class="ruby-identifier">inject</span>(<span class="ruby-value str">''</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span>,<span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">to_9p</span>(<span class="ruby-ivar">@values</span>) }
+      <span class="ruby-keyword kw">end</span></pre>
+                    </div>
+                </div>
+            </div>
+</div>
+    </div>
+  </body>
+</html>

data/doc/api/classes/Rumai/IXP/Struct/Field.html ADDED

@@ -0,0 +1,415 @@
+<?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">&lt;
+                    <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&#8217;s value is considered to be either:
+</p>
+<ul>
+<li>array of format when <tt>counter &amp;&amp; format.is_a? Class</tt>
+</li>
+<li>raw byte string when <tt>counter &amp;&amp; format.nil?</tt>
+</li>
+</ul>
+    </div>
+    <div class="sectiontitle">Methods</div>
+    <dl class="methods">
+        <dt>C</dt>
+        <dd>
+            <ul>
+                <li><a href="#M000138">countee=</a>,</li>
+                <li><a href="#M000137">counter=</a></li>
+            </ul>
+        </dd>
+        <dt>F</dt>
+        <dd>
+            <ul>
+                <li><a href="#M000139">factory</a></li>
+            </ul>
+        </dd>
+        <dt>L</dt>
+        <dd>
+            <ul>
+                <li><a href="#M000141">load_9p</a></li>
+            </ul>
+        </dd>
+        <dt>N</dt>
+        <dd>
+            <ul>
+                <li><a href="#M000136">new</a></li>
+            </ul>
+        </dd>
+        <dt>T</dt>
+        <dd>
+            <ul>
+                <li><a href="#M000140">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="M000139">
+                    <a name="M000139"></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('M000139_source')" id="l_M000139_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="M000139_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="M000136">
+                    <a name="M000136"></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&#8217;s value
+</dd>
+</dl>
+                </div>
+                <div class="sourcecode">
+                    <p class="source-link">
+                        Source: <a href="javascript:toggleSource('M000136_source')" id="l_M000136_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="M000136_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="M000138">
+                    <a name="M000138"></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('M000138_source')" id="l_M000138_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="M000138_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="M000137">
+                    <a name="M000137"></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('M000137_source')" id="l_M000137_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="M000137_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="M000141">
+                    <a name="M000141"></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('M000141_source')" id="l_M000141_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="M000141_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="M000140">
+                    <a name="M000140"></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('M000140_source')" id="l_M000140_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="M000140_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>