rumai 3.2.0 → 3.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (181) hide show
  1. data/CREDITS +4 -3
  2. data/HISTORY +327 -0
  3. data/INSTALL +31 -0
  4. data/README +92 -0
  5. data/USAGE +297 -0
  6. data/bin/rumai +9 -22
  7. data/doc/api/IO.html +119 -0
  8. data/doc/api/Integer.html +171 -0
  9. data/doc/api/Rumai.html +1270 -0
  10. data/doc/api/Rumai/Area.html +1485 -0
  11. data/doc/api/Rumai/Chain.html +301 -0
  12. data/doc/api/Rumai/Client.html +2451 -0
  13. data/doc/api/Rumai/ClientContainer.html +301 -0
  14. data/doc/api/Rumai/ExportInstanceMethods.html +103 -0
  15. data/doc/api/Rumai/IXP.html +94 -0
  16. data/doc/api/Rumai/IXP/Agent.html +1625 -0
  17. data/doc/api/Rumai/IXP/Agent/FidStream.html +959 -0
  18. data/doc/api/Rumai/IXP/Agent/RangedPool.html +381 -0
  19. data/doc/api/Rumai/IXP/Error.html +110 -0
  20. data/doc/api/Rumai/IXP/Fcall.html +503 -0
  21. data/doc/api/Rumai/IXP/Qid.html +207 -0
  22. data/doc/api/Rumai/IXP/Rattach.html +148 -0
  23. data/doc/api/Rumai/IXP/Rauth.html +148 -0
  24. data/doc/api/Rumai/IXP/Rclunk.html +148 -0
  25. data/doc/api/Rumai/IXP/Rcreate.html +148 -0
  26. data/doc/api/Rumai/IXP/Rerror.html +148 -0
  27. data/doc/api/Rumai/IXP/Rflush.html +148 -0
  28. data/doc/api/Rumai/IXP/Ropen.html +148 -0
  29. data/doc/api/Rumai/IXP/Rread.html +148 -0
  30. data/doc/api/Rumai/IXP/Rremove.html +148 -0
  31. data/doc/api/Rumai/IXP/Rstat.html +148 -0
  32. data/doc/api/Rumai/IXP/Rversion.html +148 -0
  33. data/doc/api/Rumai/IXP/Rwalk.html +148 -0
  34. data/doc/api/Rumai/IXP/Rwrite.html +148 -0
  35. data/doc/api/Rumai/IXP/Rwstat.html +148 -0
  36. data/doc/api/Rumai/IXP/Stat.html +335 -0
  37. data/doc/api/Rumai/IXP/Stream.html +194 -0
  38. data/doc/api/Rumai/IXP/Struct.html +586 -0
  39. data/doc/api/Rumai/IXP/Struct/ClassField.html +242 -0
  40. data/doc/api/Rumai/IXP/Struct/Field.html +782 -0
  41. data/doc/api/Rumai/IXP/Struct/Field/CounteeField.html +227 -0
  42. data/doc/api/Rumai/IXP/Struct/Field/CounterField.html +153 -0
  43. data/doc/api/Rumai/IXP/Struct/Integer8Field.html +242 -0
  44. data/doc/api/Rumai/IXP/Struct/StringField.html +206 -0
  45. data/doc/api/Rumai/IXP/Tattach.html +148 -0
  46. data/doc/api/Rumai/IXP/Tauth.html +148 -0
  47. data/doc/api/Rumai/IXP/Tclunk.html +148 -0
  48. data/doc/api/Rumai/IXP/Tcreate.html +148 -0
  49. data/doc/api/Rumai/IXP/Terror.html +231 -0
  50. data/doc/api/Rumai/IXP/Tflush.html +148 -0
  51. data/doc/api/Rumai/IXP/Topen.html +240 -0
  52. data/doc/api/Rumai/IXP/Tread.html +148 -0
  53. data/doc/api/Rumai/IXP/Tremove.html +148 -0
  54. data/doc/api/Rumai/IXP/Tstat.html +148 -0
  55. data/doc/api/Rumai/IXP/Tversion.html +162 -0
  56. data/doc/api/Rumai/IXP/Twalk.html +148 -0
  57. data/doc/api/Rumai/IXP/Twrite.html +148 -0
  58. data/doc/api/Rumai/IXP/Twstat.html +148 -0
  59. data/doc/api/Rumai/Node.html +1406 -0
  60. data/doc/api/Rumai/View.html +1587 -0
  61. data/doc/api/Rumai/WidgetImpl.html +333 -0
  62. data/doc/api/Rumai/WidgetNode.html +246 -0
  63. data/doc/api/String.html +258 -0
  64. data/doc/api/StringIO.html +119 -0
  65. data/doc/api/Time.html +247 -0
  66. data/doc/api/_index.html +581 -0
  67. data/doc/api/class_list.html +36 -0
  68. data/doc/api/css/common.css +1 -0
  69. data/doc/api/css/full_list.css +50 -0
  70. data/doc/api/css/style.css +273 -0
  71. data/doc/api/file.LICENSE.html +73 -0
  72. data/doc/api/file_list.html +38 -0
  73. data/doc/api/frames.html +13 -0
  74. data/doc/api/index.html +72 -13
  75. data/doc/api/js/app.js +111 -0
  76. data/doc/api/js/full_list.js +117 -0
  77. data/doc/api/js/{jquery-1.3.2.min.js → jquery.js} +0 -0
  78. data/doc/api/method_list.html +1483 -0
  79. data/doc/api/top-level-namespace.html +89 -0
  80. data/doc/index.erb +18 -13
  81. data/doc/index.html +331 -386
  82. data/lib/rumai.rb +1 -18
  83. data/lib/rumai/fs.rb +11 -11
  84. data/lib/rumai/inochi.rb +48 -0
  85. data/lib/rumai/inochi.yaml +94 -0
  86. data/lib/rumai/ixp.rb +0 -4
  87. data/lib/rumai/ixp/message.rb +6 -17
  88. data/lib/rumai/ixp/transport.rb +39 -30
  89. data/lib/rumai/wm.rb +35 -37
  90. data/test/rumai/inochi_test.rb +17 -0
  91. data/test/rumai/ixp/message_test.rb +245 -0
  92. data/test/runner +25 -0
  93. data/test/test_helper.rb +1 -0
  94. metadata +107 -125
  95. data/doc/api/apple-touch-icon.png +0 -0
  96. data/doc/api/classes/IO.html +0 -72
  97. data/doc/api/classes/Integer.html +0 -110
  98. data/doc/api/classes/Object.html +0 -60
  99. data/doc/api/classes/Rumai.html +0 -837
  100. data/doc/api/classes/Rumai/Area.html +0 -909
  101. data/doc/api/classes/Rumai/Chain.html +0 -197
  102. data/doc/api/classes/Rumai/Client.html +0 -1526
  103. data/doc/api/classes/Rumai/ClientContainer.html +0 -191
  104. data/doc/api/classes/Rumai/ExportInstanceMethods.html +0 -69
  105. data/doc/api/classes/Rumai/IXP.html +0 -131
  106. data/doc/api/classes/Rumai/IXP/Agent.html +0 -941
  107. data/doc/api/classes/Rumai/IXP/Agent/FidStream.html +0 -456
  108. data/doc/api/classes/Rumai/IXP/Agent/MODES.html +0 -108
  109. data/doc/api/classes/Rumai/IXP/Agent/RangedPool.html +0 -241
  110. data/doc/api/classes/Rumai/IXP/Error.html +0 -67
  111. data/doc/api/classes/Rumai/IXP/Fcall.html +0 -323
  112. data/doc/api/classes/Rumai/IXP/Qid.html +0 -153
  113. data/doc/api/classes/Rumai/IXP/Rattach.html +0 -67
  114. data/doc/api/classes/Rumai/IXP/Rauth.html +0 -67
  115. data/doc/api/classes/Rumai/IXP/Rclunk.html +0 -67
  116. data/doc/api/classes/Rumai/IXP/Rcreate.html +0 -67
  117. data/doc/api/classes/Rumai/IXP/Rerror.html +0 -67
  118. data/doc/api/classes/Rumai/IXP/Rflush.html +0 -67
  119. data/doc/api/classes/Rumai/IXP/Ropen.html +0 -67
  120. data/doc/api/classes/Rumai/IXP/Rread.html +0 -67
  121. data/doc/api/classes/Rumai/IXP/Rremove.html +0 -67
  122. data/doc/api/classes/Rumai/IXP/Rstat.html +0 -67
  123. data/doc/api/classes/Rumai/IXP/Rversion.html +0 -67
  124. data/doc/api/classes/Rumai/IXP/Rwalk.html +0 -67
  125. data/doc/api/classes/Rumai/IXP/Rwrite.html +0 -67
  126. data/doc/api/classes/Rumai/IXP/Rwstat.html +0 -67
  127. data/doc/api/classes/Rumai/IXP/Stat.html +0 -252
  128. data/doc/api/classes/Rumai/IXP/Stream.html +0 -131
  129. data/doc/api/classes/Rumai/IXP/Struct.html +0 -311
  130. data/doc/api/classes/Rumai/IXP/Struct/Field.html +0 -415
  131. data/doc/api/classes/Rumai/IXP/Struct/Field/CounteeField.html +0 -153
  132. data/doc/api/classes/Rumai/IXP/Struct/Field/CounterField.html +0 -104
  133. data/doc/api/classes/Rumai/IXP/Tattach.html +0 -68
  134. data/doc/api/classes/Rumai/IXP/Tauth.html +0 -67
  135. data/doc/api/classes/Rumai/IXP/Tclunk.html +0 -67
  136. data/doc/api/classes/Rumai/IXP/Tcreate.html +0 -68
  137. data/doc/api/classes/Rumai/IXP/Terror.html +0 -110
  138. data/doc/api/classes/Rumai/IXP/Tflush.html +0 -67
  139. data/doc/api/classes/Rumai/IXP/Topen.html +0 -165
  140. data/doc/api/classes/Rumai/IXP/Tread.html +0 -67
  141. data/doc/api/classes/Rumai/IXP/Tremove.html +0 -67
  142. data/doc/api/classes/Rumai/IXP/Tstat.html +0 -67
  143. data/doc/api/classes/Rumai/IXP/Tversion.html +0 -86
  144. data/doc/api/classes/Rumai/IXP/Twalk.html +0 -68
  145. data/doc/api/classes/Rumai/IXP/Twrite.html +0 -68
  146. data/doc/api/classes/Rumai/IXP/Twstat.html +0 -67
  147. data/doc/api/classes/Rumai/Node.html +0 -821
  148. data/doc/api/classes/Rumai/View.html +0 -967
  149. data/doc/api/classes/Rumai/WidgetImpl.html +0 -65
  150. data/doc/api/classes/Rumai/WidgetNode.html +0 -68
  151. data/doc/api/classes/String.html +0 -163
  152. data/doc/api/classes/StringIO.html +0 -72
  153. data/doc/api/classes/Time.html +0 -156
  154. data/doc/api/created.rid +0 -1
  155. data/doc/api/css/main.css +0 -263
  156. data/doc/api/css/panel.css +0 -383
  157. data/doc/api/css/reset.css +0 -53
  158. data/doc/api/favicon.ico +0 -0
  159. data/doc/api/files/CREDITS.html +0 -67
  160. data/doc/api/files/LICENSE.html +0 -76
  161. data/doc/api/files/lib/rumai/fs_rb.html +0 -75
  162. data/doc/api/files/lib/rumai/ixp/message_rb.html +0 -91
  163. data/doc/api/files/lib/rumai/ixp/transport_rb.html +0 -75
  164. data/doc/api/files/lib/rumai/ixp_rb.html +0 -69
  165. data/doc/api/files/lib/rumai/wm_rb.html +0 -77
  166. data/doc/api/files/lib/rumai_rb.html +0 -65
  167. data/doc/api/i/arrows.png +0 -0
  168. data/doc/api/i/results_bg.png +0 -0
  169. data/doc/api/i/tree_bg.png +0 -0
  170. data/doc/api/js/jquery-effect.js +0 -593
  171. data/doc/api/js/main.js +0 -22
  172. data/doc/api/js/searchdoc.js +0 -628
  173. data/doc/api/panel/index.html +0 -71
  174. data/doc/api/panel/search_index.js +0 -1
  175. data/doc/api/panel/tree.js +0 -1
  176. data/doc/history.erb +0 -233
  177. data/doc/intro.erb +0 -70
  178. data/doc/setup.erb +0 -144
  179. data/doc/usage.erb +0 -308
  180. data/rakefile +0 -14
  181. data/test/rumai/ixp/message.rb +0 -237
data/doc/api/Rumai/IXP/Struct/ClassField.html ADDED
@@ -0,0 +1,242 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta name="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>Class: Rumai::IXP::Struct::ClassField</title>
7
+ <link rel="stylesheet" href="../../../css/style.css" type="text/css" media="screen" charset="utf-8" />
8
+ <link rel="stylesheet" href="../../../css/common.css" type="text/css" media="screen" charset="utf-8" />
9
+
10
+ <script type="text/javascript" charset="utf-8">
11
+ relpath = '../../..';
12
+ if (relpath != '') relpath += '/';
13
+ </script>
14
+ <script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
15
+ <script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
16
+
17
+ </head>
18
+ <body>
19
+ <script type="text/javascript" charset="utf-8">
20
+ if (window.top.frames.main) document.body.className = 'frames';
21
+ </script>
22
+
23
+ <div id="header">
24
+ <div id="menu">
25
+
26
+ <a href="../../../_index.html">Index (C)</a> &raquo;
27
+ <span class='title'><a href="../../../Rumai.html" title="Rumai (module)">Rumai</a></span> &raquo; <span class='title'><a href="../../IXP.html" title="Rumai::IXP (module)">IXP</a></span> &raquo; <span class='title'><a href="../Struct.html" title="Rumai::IXP::Struct (module)">Struct</a></span>
28
+ &raquo;
29
+ <span class="title">ClassField</span>
30
+
31
+
32
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
33
+ </div>
34
+
35
+ <div id="search">
36
+ <a id="class_list_link" href="#">Class List</a>
37
+ <a id="method_list_link" href="#">Method List</a>
38
+ <a id ="file_list_link" href="#">File List</a>
39
+ </div>
40
+
41
+ <div class="clear"></div>
42
+ </div>
43
+
44
+ <iframe id="search_frame"></iframe>
45
+
46
+ <div id="content"><h1>Class: Rumai::IXP::Struct::ClassField
47
+
48
+
49
+ </h1>
50
+
51
+ <dl class="box">
52
+
53
+ <dt class="r1">Inherits:</dt>
54
+ <dd class="r1">
55
+ <span class="inheritName"><a href="Field.html" title="Rumai::IXP::Struct::Field (class)">Field</a></span>
56
+
57
+ <ul class="fullTree">
58
+ <li><a href="../../../Object.html" title="Object (class)">Object</a></li>
59
+
60
+ <li class="next"><a href="Field.html" title="Rumai::IXP::Struct::Field (class)">Field</a></li>
61
+
62
+ <li class="next">Rumai::IXP::Struct::ClassField</li>
63
+
64
+ </ul>
65
+ <a href="#" class="inheritanceTree">show all</a>
66
+
67
+ </dd>
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+ <dt class="r2 last">Defined in:</dt>
78
+ <dd class="r2 last">lib/rumai/ixp/message.rb</dd>
79
+
80
+ </dl>
81
+ <div class="clear"></div>
82
+
83
+ <h2>Overview</h2><div class="docstring">
84
+ <div class="discussion">
85
+ <p>
86
+ A field whose value knows how to convert itself to and from 9p.
87
+ </p>
88
+
89
+
90
+ </div>
91
+ </div>
92
+ <div class="tags">
93
+
94
+ </div><div id="subclasses">
95
+ <h2>Direct Known Subclasses</h2>
96
+ <p class="children"><a href="StringField.html" title="Rumai::IXP::Struct::StringField (class)">StringField</a></p>
97
+ </div>
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+ <h2>Instance Method Summary</h2>
107
+
108
+ <ul class="summary">
109
+
110
+ <li class="public ">
111
+ <span class="summary_signature">
112
+
113
+ <a href="#value_from_9p-instance_method" title="#value_from_9p (instance method)">- (Object) <strong>value_from_9p</strong>(stream) </a>
114
+
115
+
116
+
117
+ </span>
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+ <span class="summary_desc"><div class='inline'></div></span>
126
+
127
+ </li>
128
+
129
+
130
+ <li class="public ">
131
+ <span class="summary_signature">
132
+
133
+ <a href="#value_to_9p-instance_method" title="#value_to_9p (instance method)">- (Object) <strong>value_to_9p</strong>(value) </a>
134
+
135
+
136
+
137
+ </span>
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+ <span class="summary_desc"><div class='inline'></div></span>
146
+
147
+ </li>
148
+
149
+
150
+ </ul>
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+ <h3 class="inherited">Methods inherited from <a href="Field.html" title="Rumai::IXP::Struct::Field (class)">Field</a></h3>
162
+ <p class="inherited"><a href="Field.html#factory-class_method" title="Rumai::IXP::Struct::Field.factory (method)">factory</a>, <a href="Field.html#initialize-instance_method" title="Rumai::IXP::Struct::Field#initialize (method)">#initialize</a>, <a href="Field.html#load_9p-instance_method" title="Rumai::IXP::Struct::Field#load_9p (method)">#load_9p</a>, <a href="Field.html#to_9p-instance_method" title="Rumai::IXP::Struct::Field#to_9p (method)">#to_9p</a></p>
163
+ <div id="constructor_details" class="method_details_list">
164
+ <h2>Constructor Details</h2>
165
+
166
+ <p class="notice">This class inherits a constructor from <a href="Field.html#initialize-instance_method" title="Rumai::IXP::Struct::Field#initialize (method)">Rumai::IXP::Struct::Field</a></p>
167
+
168
+ </div>
169
+
170
+
171
+ <div id="instance_method_details" class="method_details_list">
172
+ <h2>Instance Method Details</h2>
173
+
174
+
175
+ <div class="method_details first">
176
+ <p class="signature first" id="value_from_9p-instance_method">
177
+
178
+ - (<tt><a href="../../../Object.html" title="Object (class)">Object</a></tt>) <strong>value_from_9p</strong>(stream)
179
+
180
+
181
+
182
+ </p><table class="source_code">
183
+ <tr>
184
+ <td>
185
+ <pre class="lines">
186
+
187
+
188
+ 276
189
+ 277
190
+ 278</pre>
191
+ </td>
192
+ <td>
193
+ <pre class="code"><span class="info file"># File 'lib/rumai/ixp/message.rb', line 276</span>
194
+
195
+ <span class='kw'>def</span> <span class='id value_from_9p'>value_from_9p</span> <span class='id stream'>stream</span>
196
+ <span class='ivar'>@format</span><span class='period'>.</span><span class='id from_9p'>from_9p</span> <span class='id stream'>stream</span>
197
+ <span class='kw'>end</span></pre>
198
+ </td>
199
+ </tr>
200
+ </table>
201
+ </div>
202
+
203
+ <div class="method_details ">
204
+ <p class="signature " id="value_to_9p-instance_method">
205
+
206
+ - (<tt><a href="../../../Object.html" title="Object (class)">Object</a></tt>) <strong>value_to_9p</strong>(value)
207
+
208
+
209
+
210
+ </p><table class="source_code">
211
+ <tr>
212
+ <td>
213
+ <pre class="lines">
214
+
215
+
216
+ 272
217
+ 273
218
+ 274</pre>
219
+ </td>
220
+ <td>
221
+ <pre class="code"><span class="info file"># File 'lib/rumai/ixp/message.rb', line 272</span>
222
+
223
+ <span class='kw'>def</span> <span class='id value_to_9p'>value_to_9p</span> <span class='id value'>value</span>
224
+ <span class='id value'>value</span><span class='period'>.</span><span class='id to_9p'>to_9p</span>
225
+ <span class='kw'>end</span></pre>
226
+ </td>
227
+ </tr>
228
+ </table>
229
+ </div>
230
+
231
+ </div>
232
+
233
+ </div>
234
+
235
+ <div id="footer">
236
+ Generated on Mon Mar 22 22:23:56 2010 by
237
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
238
+ 0.5.4 (ruby-1.9.1).
239
+ </div>
240
+
241
+ </body>
242
+ </html>
data/doc/api/Rumai/IXP/Struct/Field.html ADDED
@@ -0,0 +1,782 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta name="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>Class: Rumai::IXP::Struct::Field</title>
7
+ <link rel="stylesheet" href="../../../css/style.css" type="text/css" media="screen" charset="utf-8" />
8
+ <link rel="stylesheet" href="../../../css/common.css" type="text/css" media="screen" charset="utf-8" />
9
+
10
+ <script type="text/javascript" charset="utf-8">
11
+ relpath = '../../..';
12
+ if (relpath != '') relpath += '/';
13
+ </script>
14
+ <script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
15
+ <script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
16
+
17
+ </head>
18
+ <body>
19
+ <script type="text/javascript" charset="utf-8">
20
+ if (window.top.frames.main) document.body.className = 'frames';
21
+ </script>
22
+
23
+ <div id="header">
24
+ <div id="menu">
25
+
26
+ <a href="../../../_index.html">Index (F)</a> &raquo;
27
+ <span class='title'><a href="../../../Rumai.html" title="Rumai (module)">Rumai</a></span> &raquo; <span class='title'><a href="../../IXP.html" title="Rumai::IXP (module)">IXP</a></span> &raquo; <span class='title'><a href="../Struct.html" title="Rumai::IXP::Struct (module)">Struct</a></span>
28
+ &raquo;
29
+ <span class="title">Field</span>
30
+
31
+
32
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
33
+ </div>
34
+
35
+ <div id="search">
36
+ <a id="class_list_link" href="#">Class List</a>
37
+ <a id="method_list_link" href="#">Method List</a>
38
+ <a id ="file_list_link" href="#">File List</a>
39
+ </div>
40
+
41
+ <div class="clear"></div>
42
+ </div>
43
+
44
+ <iframe id="search_frame"></iframe>
45
+
46
+ <div id="content"><h1>Class: Rumai::IXP::Struct::Field
47
+
48
+
49
+ </h1>
50
+
51
+ <dl class="box">
52
+
53
+ <dt class="r1">Inherits:</dt>
54
+ <dd class="r1">
55
+ <span class="inheritName"><a href="../../../Object.html" title="Object (class)">Object</a></span>
56
+
57
+ <ul class="fullTree">
58
+ <li><a href="../../../Object.html" title="Object (class)">Object</a></li>
59
+
60
+ <li class="next">Rumai::IXP::Struct::Field</li>
61
+
62
+ </ul>
63
+ <a href="#" class="inheritanceTree">show all</a>
64
+
65
+ </dd>
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+ <dt class="r2 last">Defined in:</dt>
76
+ <dd class="r2 last">lib/rumai/ixp/message.rb</dd>
77
+
78
+ </dl>
79
+ <div class="clear"></div>
80
+
81
+ <h2>Overview</h2><div class="docstring">
82
+ <div class="discussion">
83
+ <p>
84
+ A field inside a Struct.
85
+ </p>
86
+ <p>
87
+ A field&#8217;s value is considered to be either:
88
+ </p>
89
+ <ul>
90
+ <li>array of format when <tt>counter &amp;&amp; format.is_a? Class</tt>
91
+
92
+ </li>
93
+ <li>raw byte string when <tt>counter &amp;&amp; format.nil?</tt>
94
+
95
+ </li>
96
+ </ul>
97
+
98
+
99
+ </div>
100
+ </div>
101
+ <div class="tags">
102
+
103
+ </div><div id="subclasses">
104
+ <h2>Direct Known Subclasses</h2>
105
+ <p class="children"><a href="ClassField.html" title="Rumai::IXP::Struct::ClassField (class)">ClassField</a>, <a href="Integer8Field.html" title="Rumai::IXP::Struct::Integer8Field (class)">Integer8Field</a></p>
106
+ </div>
107
+ <h2>Defined Under Namespace</h2>
108
+ <p class="children">
109
+
110
+
111
+ <strong class="modules">Modules:</strong> <a href="Field/CounteeField.html" title="Rumai::IXP::Struct::Field::CounteeField (module)">CounteeField</a>, <a href="Field/CounterField.html" title="Rumai::IXP::Struct::Field::CounterField (module)">CounterField</a>
112
+
113
+
114
+
115
+
116
+ </p>
117
+
118
+
119
+ <h2>Instance Attribute Summary</h2>
120
+ <ul class="summary">
121
+
122
+ <li class="public ">
123
+ <span class="summary_signature">
124
+
125
+ <a href="#countee-instance_method" title="#countee (instance method)">- (Object) <strong>countee</strong> </a>
126
+
127
+
128
+
129
+ </span>
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+ <span class="summary_desc"><div class='inline'><p>
141
+ Returns the value of attribute countee.
142
+ </p>
143
+ </div></span>
144
+
145
+ </li>
146
+
147
+
148
+ <li class="public ">
149
+ <span class="summary_signature">
150
+
151
+ <a href="#counter-instance_method" title="#counter (instance method)">- (Object) <strong>counter</strong> </a>
152
+
153
+
154
+
155
+ </span>
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+ <span class="summary_desc"><div class='inline'><p>
167
+ Returns the value of attribute counter.
168
+ </p>
169
+ </div></span>
170
+
171
+ </li>
172
+
173
+
174
+ <li class="public ">
175
+ <span class="summary_signature">
176
+
177
+ <a href="#format-instance_method" title="#format (instance method)">- (Object) <strong>format</strong> </a>
178
+
179
+
180
+
181
+ </span>
182
+
183
+
184
+ <span class="note title readonly">readonly</span>
185
+
186
+
187
+
188
+
189
+
190
+
191
+
192
+ <span class="summary_desc"><div class='inline'><p>
193
+ Returns the value of attribute format.
194
+ </p>
195
+ </div></span>
196
+
197
+ </li>
198
+
199
+
200
+ <li class="public ">
201
+ <span class="summary_signature">
202
+
203
+ <a href="#name-instance_method" title="#name (instance method)">- (Object) <strong>name</strong> </a>
204
+
205
+
206
+
207
+ </span>
208
+
209
+
210
+ <span class="note title readonly">readonly</span>
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+ <span class="summary_desc"><div class='inline'><p>
219
+ Returns the value of attribute name.
220
+ </p>
221
+ </div></span>
222
+
223
+ </li>
224
+
225
+
226
+ </ul>
227
+
228
+
229
+
230
+ <h2>Class Method Summary</h2>
231
+
232
+ <ul class="summary">
233
+
234
+ <li class="public ">
235
+ <span class="summary_signature">
236
+
237
+ <a href="#factory-class_method" title="factory (class method)">+ (Object) <strong>factory</strong>(format) </a>
238
+
239
+
240
+
241
+ </span>
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+ <span class="summary_desc"><div class='inline'><p>
250
+ Returns a Field class that best represents the given format.
251
+ </p>
252
+ </div></span>
253
+
254
+ </li>
255
+
256
+
257
+ </ul>
258
+
259
+ <h2>Instance Method Summary</h2>
260
+
261
+ <ul class="summary">
262
+
263
+ <li class="public ">
264
+ <span class="summary_signature">
265
+
266
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Field) <strong>initialize</strong>(name, format = nil, counter = nil) </a>
267
+
268
+
269
+
270
+ </span>
271
+
272
+ <span class="note title constructor">constructor</span>
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+ <span class="summary_desc"><div class='inline'><p>
281
+ A new instance of Field.
282
+ </p>
283
+ </div></span>
284
+
285
+ </li>
286
+
287
+
288
+ <li class="public ">
289
+ <span class="summary_signature">
290
+
291
+ <a href="#load_9p-instance_method" title="#load_9p (instance method)">- (Object) <strong>load_9p</strong>(stream, field_values) </a>
292
+
293
+
294
+
295
+ </span>
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+ <span class="summary_desc"><div class='inline'><p>
304
+ Populates this object with information taken from the given 9P2000 byte
305
+ stream.
306
+ </p>
307
+ </div></span>
308
+
309
+ </li>
310
+
311
+
312
+ <li class="public ">
313
+ <span class="summary_signature">
314
+
315
+ <a href="#to_9p-instance_method" title="#to_9p (instance method)">- (Object) <strong>to_9p</strong>(field_values) </a>
316
+
317
+
318
+
319
+ </span>
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+ <span class="summary_desc"><div class='inline'><p>
328
+ Transforms this object into a string of 9P2000 bytes.
329
+ </p>
330
+ </div></span>
331
+
332
+ </li>
333
+
334
+
335
+ </ul>
336
+
337
+
338
+ <div id="constructor_details" class="method_details_list">
339
+ <h2>Constructor Details</h2>
340
+
341
+ <div class="method_details first">
342
+ <p class="signature first" id="initialize-instance_method">
343
+
344
+ - (<tt><a href="" title="Rumai::IXP::Struct::Field (class)">Field</a></tt>) <strong>initialize</strong>(name, format = nil, counter = nil)
345
+
346
+
347
+
348
+ </p><div class="docstring">
349
+ <div class="discussion">
350
+ <p>
351
+ A new instance of Field
352
+ </p>
353
+
354
+
355
+ </div>
356
+ </div>
357
+ <div class="tags">
358
+ <h3>Parameters:</h3>
359
+ <ul class="param">
360
+
361
+ <li>
362
+
363
+ <span class='type'>(<tt>among all fields in a struct</tt>)</span>
364
+
365
+
366
+ <span class='name'>nameunique</span>
367
+
368
+
369
+
370
+ &mdash;
371
+ <div class='inline'><p>
372
+ name for the field
373
+ </p>
374
+ </div>
375
+
376
+ </li>
377
+
378
+ <li>
379
+
380
+ <span class='type'></span>
381
+
382
+
383
+ <span class='name'>format</span>
384
+
385
+
386
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
387
+
388
+
389
+ &mdash;
390
+ <div class='inline'><p>
391
+ number of bytes, a class, or nil
392
+ </p>
393
+ </div>
394
+
395
+ </li>
396
+
397
+ <li>
398
+
399
+ <span class='type'>(<tt><a href="" title="Rumai::IXP::Struct::Field (class)">Field</a></tt>)</span>
400
+
401
+
402
+ <span class='name'>counter</span>
403
+
404
+
405
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
406
+
407
+
408
+ &mdash;
409
+ <div class='inline'><p>
410
+ field which counts the length of this field&#8217;s value
411
+ </p>
412
+ </div>
413
+
414
+ </li>
415
+
416
+ </ul>
417
+
418
+ </div><table class="source_code">
419
+ <tr>
420
+ <td>
421
+ <pre class="lines">
422
+
423
+
424
+ 153
425
+ 154
426
+ 155
427
+ 156
428
+ 157
429
+ 158</pre>
430
+ </td>
431
+ <td>
432
+ <pre class="code"><span class="info file"># File 'lib/rumai/ixp/message.rb', line 153</span>
433
+
434
+ <span class='kw'>def</span> <span class='id initialize'>initialize</span> <span class='id name'>name</span><span class='comma'>,</span> <span class='id format'>format</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id counter'>counter</span> <span class='op'>=</span> <span class='kw'>nil</span>
435
+ <span class='ivar'>@name</span> <span class='op'>=</span> <span class='id name'>name</span>
436
+ <span class='ivar'>@format</span> <span class='op'>=</span> <span class='id format'>format</span>
437
+ <span class='ivar'>@countee</span> <span class='op'>=</span> <span class='kw'>nil</span>
438
+ <span class='kw'>self</span><span class='period'>.</span><span class='id counter'>counter</span> <span class='op'>=</span> <span class='id counter'>counter</span>
439
+ <span class='kw'>end</span></pre>
440
+ </td>
441
+ </tr>
442
+ </table>
443
+ </div>
444
+
445
+ </div>
446
+
447
+ <div id="instance_attr_details" class="attr_details">
448
+ <h2>Instance Attribute Details</h2>
449
+
450
+
451
+ <span id="countee=-instance_method"></span>
452
+ <span id="countee-instance_method"></span>
453
+ <div class="method_details first">
454
+ <p class="signature first" id="countee-instance_method">
455
+
456
+ - (<tt><a href="../../../Object.html" title="Object (class)">Object</a></tt>) <strong>countee</strong>
457
+
458
+
459
+
460
+ </p><div class="docstring">
461
+ <div class="discussion">
462
+ <p>
463
+ Returns the value of attribute countee
464
+ </p>
465
+
466
+
467
+ </div>
468
+ </div>
469
+ <div class="tags">
470
+
471
+ </div><table class="source_code">
472
+ <tr>
473
+ <td>
474
+ <pre class="lines">
475
+
476
+
477
+ 141
478
+ 142
479
+ 143</pre>
480
+ </td>
481
+ <td>
482
+ <pre class="code"><span class="info file"># File 'lib/rumai/ixp/message.rb', line 141</span>
483
+
484
+ <span class='kw'>def</span> <span class='id countee'>countee</span>
485
+ <span class='ivar'>@countee</span>
486
+ <span class='kw'>end</span></pre>
487
+ </td>
488
+ </tr>
489
+ </table>
490
+ </div>
491
+
492
+
493
+ <span id="counter=-instance_method"></span>
494
+ <span id="counter-instance_method"></span>
495
+ <div class="method_details ">
496
+ <p class="signature " id="counter-instance_method">
497
+
498
+ - (<tt><a href="../../../Object.html" title="Object (class)">Object</a></tt>) <strong>counter</strong>
499
+
500
+
501
+
502
+ </p><div class="docstring">
503
+ <div class="discussion">
504
+ <p>
505
+ Returns the value of attribute counter
506
+ </p>
507
+
508
+
509
+ </div>
510
+ </div>
511
+ <div class="tags">
512
+
513
+ </div><table class="source_code">
514
+ <tr>
515
+ <td>
516
+ <pre class="lines">
517
+
518
+
519
+ 141
520
+ 142
521
+ 143</pre>
522
+ </td>
523
+ <td>
524
+ <pre class="code"><span class="info file"># File 'lib/rumai/ixp/message.rb', line 141</span>
525
+
526
+ <span class='kw'>def</span> <span class='id counter'>counter</span>
527
+ <span class='ivar'>@counter</span>
528
+ <span class='kw'>end</span></pre>
529
+ </td>
530
+ </tr>
531
+ </table>
532
+ </div>
533
+
534
+
535
+ <span id=""></span>
536
+ <span id="format-instance_method"></span>
537
+ <div class="method_details ">
538
+ <p class="signature " id="format-instance_method">
539
+
540
+ - (<tt><a href="../../../Object.html" title="Object (class)">Object</a></tt>) <strong>format</strong> <span class="extras">(readonly)</span>
541
+
542
+
543
+
544
+ </p><div class="docstring">
545
+ <div class="discussion">
546
+ <p>
547
+ Returns the value of attribute format
548
+ </p>
549
+
550
+
551
+ </div>
552
+ </div>
553
+ <div class="tags">
554
+
555
+ </div><table class="source_code">
556
+ <tr>
557
+ <td>
558
+ <pre class="lines">
559
+
560
+
561
+ 141
562
+ 142
563
+ 143</pre>
564
+ </td>
565
+ <td>
566
+ <pre class="code"><span class="info file"># File 'lib/rumai/ixp/message.rb', line 141</span>
567
+
568
+ <span class='kw'>def</span> <span class='id format'>format</span>
569
+ <span class='ivar'>@format</span>
570
+ <span class='kw'>end</span></pre>
571
+ </td>
572
+ </tr>
573
+ </table>
574
+ </div>
575
+
576
+
577
+ <span id=""></span>
578
+ <span id="name-instance_method"></span>
579
+ <div class="method_details ">
580
+ <p class="signature " id="name-instance_method">
581
+
582
+ - (<tt><a href="../../../Object.html" title="Object (class)">Object</a></tt>) <strong>name</strong> <span class="extras">(readonly)</span>
583
+
584
+
585
+
586
+ </p><div class="docstring">
587
+ <div class="discussion">
588
+ <p>
589
+ Returns the value of attribute name
590
+ </p>
591
+
592
+
593
+ </div>
594
+ </div>
595
+ <div class="tags">
596
+
597
+ </div><table class="source_code">
598
+ <tr>
599
+ <td>
600
+ <pre class="lines">
601
+
602
+
603
+ 141
604
+ 142
605
+ 143</pre>
606
+ </td>
607
+ <td>
608
+ <pre class="code"><span class="info file"># File 'lib/rumai/ixp/message.rb', line 141</span>
609
+
610
+ <span class='kw'>def</span> <span class='id name'>name</span>
611
+ <span class='ivar'>@name</span>
612
+ <span class='kw'>end</span></pre>
613
+ </td>
614
+ </tr>
615
+ </table>
616
+ </div>
617
+
618
+ </div>
619
+
620
+
621
+ <div id="class_method_details" class="method_details_list">
622
+ <h2>Class Method Details</h2>
623
+
624
+
625
+ <div class="method_details first">
626
+ <p class="signature first" id="factory-class_method">
627
+
628
+ + (<tt><a href="../../../Object.html" title="Object (class)">Object</a></tt>) <strong>factory</strong>(format)
629
+
630
+
631
+
632
+ </p><div class="docstring">
633
+ <div class="discussion">
634
+ <p>
635
+ Returns a Field class that best represents the given format.
636
+ </p>
637
+
638
+
639
+ </div>
640
+ </div>
641
+ <div class="tags">
642
+
643
+ </div><table class="source_code">
644
+ <tr>
645
+ <td>
646
+ <pre class="lines">
647
+
648
+
649
+ 184
650
+ 185
651
+ 186
652
+ 187
653
+ 188
654
+ 189
655
+ 190
656
+ 191
657
+ 192
658
+ 193
659
+ 194
660
+ 195
661
+ 196
662
+ 197</pre>
663
+ </td>
664
+ <td>
665
+ <pre class="code"><span class="info file"># File 'lib/rumai/ixp/message.rb', line 184</span>
666
+
667
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id factory'>factory</span> <span class='id format'>format</span>
668
+ <span class='kw'>if</span> <span class='id format'>format</span> <span class='op'>==</span> <span class='const'>String</span>
669
+ <span class='const'>StringField</span>
670
+
671
+ <span class='kw'>elsif</span> <span class='id format'>format</span><span class='period'>.</span><span class='id is_a?'>is_a?</span> <span class='const'>Class</span>
672
+ <span class='const'>ClassField</span>
673
+
674
+ <span class='kw'>elsif</span> <span class='id format'>format</span> <span class='op'>==</span> <span class='int'>8</span>
675
+ <span class='const'>Integer8Field</span>
676
+
677
+ <span class='kw'>else</span>
678
+ <span class='const'>Field</span>
679
+ <span class='kw'>end</span>
680
+ <span class='kw'>end</span></pre>
681
+ </td>
682
+ </tr>
683
+ </table>
684
+ </div>
685
+
686
+ </div>
687
+
688
+ <div id="instance_method_details" class="method_details_list">
689
+ <h2>Instance Method Details</h2>
690
+
691
+
692
+ <div class="method_details first">
693
+ <p class="signature first" id="load_9p-instance_method">
694
+
695
+ - (<tt><a href="../../../Object.html" title="Object (class)">Object</a></tt>) <strong>load_9p</strong>(stream, field_values)
696
+
697
+
698
+
699
+ </p><div class="docstring">
700
+ <div class="discussion">
701
+ <p>
702
+ Populates this object with information taken from the given 9P2000 byte
703
+ stream.
704
+ </p>
705
+
706
+
707
+ </div>
708
+ </div>
709
+ <div class="tags">
710
+
711
+ </div><table class="source_code">
712
+ <tr>
713
+ <td>
714
+ <pre class="lines">
715
+
716
+
717
+ 210
718
+ 211
719
+ 212</pre>
720
+ </td>
721
+ <td>
722
+ <pre class="code"><span class="info file"># File 'lib/rumai/ixp/message.rb', line 210</span>
723
+
724
+ <span class='kw'>def</span> <span class='id load_9p'>load_9p</span> <span class='id stream'>stream</span><span class='comma'>,</span> <span class='id field_values'>field_values</span>
725
+ <span class='id field_values'>field_values</span><span class='lbracket'>[</span><span class='ivar'>@name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id value_from_9p'>value_from_9p</span> <span class='id stream'>stream</span>
726
+ <span class='kw'>end</span></pre>
727
+ </td>
728
+ </tr>
729
+ </table>
730
+ </div>
731
+
732
+ <div class="method_details ">
733
+ <p class="signature " id="to_9p-instance_method">
734
+
735
+ - (<tt><a href="../../../Object.html" title="Object (class)">Object</a></tt>) <strong>to_9p</strong>(field_values)
736
+
737
+
738
+
739
+ </p><div class="docstring">
740
+ <div class="discussion">
741
+ <p>
742
+ Transforms this object into a string of 9P2000 bytes.
743
+ </p>
744
+
745
+
746
+ </div>
747
+ </div>
748
+ <div class="tags">
749
+
750
+ </div><table class="source_code">
751
+ <tr>
752
+ <td>
753
+ <pre class="lines">
754
+
755
+
756
+ 202
757
+ 203
758
+ 204</pre>
759
+ </td>
760
+ <td>
761
+ <pre class="code"><span class="info file"># File 'lib/rumai/ixp/message.rb', line 202</span>
762
+
763
+ <span class='kw'>def</span> <span class='id to_9p'>to_9p</span> <span class='id field_values'>field_values</span>
764
+ <span class='id value_to_9p'>value_to_9p</span> <span class='id field_values'>field_values</span><span class='lbracket'>[</span><span class='ivar'>@name</span><span class='rbracket'>]</span>
765
+ <span class='kw'>end</span></pre>
766
+ </td>
767
+ </tr>
768
+ </table>
769
+ </div>
770
+
771
+ </div>
772
+
773
+ </div>
774
+
775
+ <div id="footer">
776
+ Generated on Mon Mar 22 22:23:55 2010 by
777
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
778
+ 0.5.4 (ruby-1.9.1).
779
+ </div>
780
+
781
+ </body>
782
+ </html>