mangrove 0.3.0 → 0.5.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.
@@ -0,0 +1,434 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Exception: Mangrove::Result::ControlSignal
8
+
9
+ &mdash; Documentation by YARD 0.9.34
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "Mangrove::Result::ControlSignal";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (C)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../Mangrove.html" title="Mangrove (module)">Mangrove</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Result.html" title="Mangrove::Result (module)">Result</a></span></span>
41
+ &raquo;
42
+ <span class="title">ControlSignal</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Exception: Mangrove::Result::ControlSignal
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">StandardError</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">StandardError</li>
78
+
79
+ <li class="next">Mangrove::Result::ControlSignal</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+ <dl>
91
+ <dt>Extended by:</dt>
92
+ <dd>T::Sig</dd>
93
+ </dl>
94
+
95
+
96
+
97
+ <dl>
98
+ <dt>Includes:</dt>
99
+ <dd><span class='object_link'><a href="../ControlFlow/ControlSignal.html" title="Mangrove::ControlFlow::ControlSignal (module)">ControlFlow::ControlSignal</a></span></dd>
100
+ </dl>
101
+
102
+
103
+
104
+
105
+
106
+
107
+ <dl>
108
+ <dt>Defined in:</dt>
109
+ <dd>lib/mangrove/result/control_signal.rb</dd>
110
+ </dl>
111
+
112
+ </div>
113
+
114
+
115
+
116
+
117
+
118
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
119
+ <ul class="summary">
120
+
121
+ <li class="public ">
122
+ <span class="summary_signature">
123
+
124
+ <a href="#inner_value-instance_method" title="#inner_value (instance method)">#<strong>inner_value</strong> &#x21d2; T.untyped </a>
125
+
126
+
127
+
128
+ </span>
129
+
130
+
131
+
132
+
133
+ <span class="note title readonly">readonly</span>
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+ <span class="summary_desc"><div class='inline'></div></span>
144
+
145
+ </li>
146
+
147
+
148
+ </ul>
149
+
150
+
151
+
152
+
153
+
154
+ <h2>
155
+ Instance Method Summary
156
+ <small><a href="#" class="summary_toggle">collapse</a></small>
157
+ </h2>
158
+
159
+ <ul class="summary">
160
+
161
+ <li class="public ">
162
+ <span class="summary_signature">
163
+
164
+ <a href="#==-instance_method" title="#== (instance method)">#<strong>==</strong>(other) &#x21d2; Boolean </a>
165
+
166
+
167
+
168
+ </span>
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+ <span class="summary_desc"><div class='inline'></div></span>
179
+
180
+ </li>
181
+
182
+
183
+ <li class="public ">
184
+ <span class="summary_signature">
185
+
186
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(inner_value) &#x21d2; void </a>
187
+
188
+
189
+
190
+ </span>
191
+
192
+
193
+ <span class="note title constructor">constructor</span>
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+ <span class="summary_desc"><div class='inline'></div></span>
203
+
204
+ </li>
205
+
206
+
207
+ </ul>
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+ <div id="constructor_details" class="method_details_list">
221
+ <h2>Constructor Details</h2>
222
+
223
+ <div class="method_details first">
224
+ <h3 class="signature first" id="initialize-instance_method">
225
+
226
+ #<strong>initialize</strong>(inner_value) &#x21d2; <tt>void</tt>
227
+
228
+
229
+
230
+
231
+
232
+ </h3><div class="docstring">
233
+ <div class="discussion">
234
+
235
+
236
+ </div>
237
+ </div>
238
+ <div class="tags">
239
+ <p class="tag_title">Parameters:</p>
240
+ <ul class="param">
241
+
242
+ <li>
243
+
244
+ <span class='name'>inner_value</span>
245
+
246
+
247
+ <span class='type'>(<tt>T.untyped</tt>)</span>
248
+
249
+
250
+
251
+ </li>
252
+
253
+ </ul>
254
+
255
+
256
+ </div><table class="source_code">
257
+ <tr>
258
+ <td>
259
+ <pre class="lines">
260
+
261
+
262
+ 14
263
+ 15
264
+ 16
265
+ 17</pre>
266
+ </td>
267
+ <td>
268
+ <pre class="code"><span class="info file"># File 'lib/mangrove/result/control_signal.rb', line 14</span>
269
+
270
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_inner_value'>inner_value</span><span class='rparen'>)</span>
271
+ <span class='ivar'>@inner_value</span> <span class='op'>=</span> <span class='id identifier rubyid_inner_value'>inner_value</span>
272
+ <span class='kw'>super</span>
273
+ <span class='kw'>end</span></pre>
274
+ </td>
275
+ </tr>
276
+ </table>
277
+ </div>
278
+
279
+ </div>
280
+
281
+ <div id="instance_attr_details" class="attr_details">
282
+ <h2>Instance Attribute Details</h2>
283
+
284
+
285
+ <span id=""></span>
286
+ <div class="method_details first">
287
+ <h3 class="signature first" id="inner_value-instance_method">
288
+
289
+ #<strong>inner_value</strong> &#x21d2; <tt>T.untyped</tt> <span class="extras">(readonly)</span>
290
+
291
+
292
+
293
+
294
+
295
+ </h3><div class="docstring">
296
+ <div class="discussion">
297
+
298
+
299
+ </div>
300
+ </div>
301
+ <div class="tags">
302
+
303
+ <p class="tag_title">Returns:</p>
304
+ <ul class="return">
305
+
306
+ <li>
307
+
308
+
309
+ <span class='type'>(<tt>T.untyped</tt>)</span>
310
+
311
+
312
+
313
+ </li>
314
+
315
+ </ul>
316
+
317
+ </div><table class="source_code">
318
+ <tr>
319
+ <td>
320
+ <pre class="lines">
321
+
322
+
323
+ 30
324
+ 31
325
+ 32</pre>
326
+ </td>
327
+ <td>
328
+ <pre class="code"><span class="info file"># File 'lib/mangrove/result/control_signal.rb', line 30</span>
329
+
330
+ <span class='kw'>def</span> <span class='id identifier rubyid_inner_value'>inner_value</span>
331
+ <span class='ivar'>@inner_value</span>
332
+ <span class='kw'>end</span></pre>
333
+ </td>
334
+ </tr>
335
+ </table>
336
+ </div>
337
+
338
+ </div>
339
+
340
+
341
+ <div id="instance_method_details" class="method_details_list">
342
+ <h2>Instance Method Details</h2>
343
+
344
+
345
+ <div class="method_details first">
346
+ <h3 class="signature first" id="==-instance_method">
347
+
348
+ #<strong>==</strong>(other) &#x21d2; <tt>Boolean</tt>
349
+
350
+
351
+
352
+
353
+
354
+ </h3><div class="docstring">
355
+ <div class="discussion">
356
+
357
+
358
+ </div>
359
+ </div>
360
+ <div class="tags">
361
+ <p class="tag_title">Parameters:</p>
362
+ <ul class="param">
363
+
364
+ <li>
365
+
366
+ <span class='name'>other</span>
367
+
368
+
369
+ <span class='type'>(<tt>BasicObject</tt>)</span>
370
+
371
+
372
+
373
+ </li>
374
+
375
+ </ul>
376
+
377
+ <p class="tag_title">Returns:</p>
378
+ <ul class="return">
379
+
380
+ <li>
381
+
382
+
383
+ <span class='type'>(<tt>Boolean</tt>)</span>
384
+
385
+
386
+
387
+ </li>
388
+
389
+ </ul>
390
+
391
+ </div><table class="source_code">
392
+ <tr>
393
+ <td>
394
+ <pre class="lines">
395
+
396
+
397
+ 20
398
+ 21
399
+ 22
400
+ 23
401
+ 24
402
+ 25
403
+ 26
404
+ 27</pre>
405
+ </td>
406
+ <td>
407
+ <pre class="code"><span class="info file"># File 'lib/mangrove/result/control_signal.rb', line 20</span>
408
+
409
+ <span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
410
+ <span class='kw'>case</span> <span class='id identifier rubyid_other'>other</span>
411
+ <span class='kw'>when</span> <span class='const'><span class='object_link'><a href="" title="Mangrove::Result::ControlSignal (class)">ControlSignal</a></span></span>
412
+ <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_inner_value'>inner_value</span> <span class='op'>==</span> <span class='id identifier rubyid_inner_value'>inner_value</span>
413
+ <span class='kw'>else</span>
414
+ <span class='kw'>false</span>
415
+ <span class='kw'>end</span>
416
+ <span class='kw'>end</span></pre>
417
+ </td>
418
+ </tr>
419
+ </table>
420
+ </div>
421
+
422
+ </div>
423
+
424
+ </div>
425
+
426
+ <div id="footer">
427
+ Generated on Thu Aug 31 15:04:26 2023 by
428
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
429
+ 0.9.34 (ruby-3.2.2).
430
+ </div>
431
+
432
+ </div>
433
+ </body>
434
+ </html>