mangrove 0.4.0 → 0.6.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.
- checksums.yaml +4 -4
- data/README.md +6 -2
- data/Rakefile +14 -1
- data/docs/Mangrove/ControlFlow/ControlSignal.html +223 -0
- data/docs/Mangrove/ControlFlow/Handler/ClassMethods.html +563 -0
- data/docs/Mangrove/ControlFlow/Handler.html +139 -0
- data/docs/Mangrove/ControlFlow/Rewriter.html +331 -0
- data/docs/Mangrove/ControlFlow.html +254 -0
- data/docs/Mangrove/Option/ControlSignal.html +434 -0
- data/docs/Mangrove/Option/None.html +978 -0
- data/docs/Mangrove/Option/Some.html +1108 -0
- data/docs/Mangrove/Option.html +942 -0
- data/docs/Mangrove/Result/ControlSignal.html +434 -0
- data/docs/Mangrove/Result/Err.html +953 -0
- data/docs/Mangrove/Result/Ok.html +927 -0
- data/docs/Mangrove/Result.html +889 -0
- data/docs/Mangrove.html +144 -0
- data/docs/_index.html +257 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +497 -0
- data/docs/file.README.html +176 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +176 -0
- data/docs/js/app.js +314 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +619 -0
- data/docs/top-level-namespace.html +110 -0
- data/hooks/pre-push +2 -0
- data/lib/mangrove/option.rb +13 -0
- data/lib/mangrove/result.rb +42 -23
- data/lib/mangrove/version.rb +1 -1
- metadata +31 -2
|
@@ -0,0 +1,953 @@
|
|
|
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
|
+
Class: Mangrove::Result::Err
|
|
8
|
+
|
|
9
|
+
— 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::Err";
|
|
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 (E)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../Mangrove.html" title="Mangrove (module)">Mangrove</a></span></span> » <span class='title'><span class='object_link'><a href="../Result.html" title="Mangrove::Result (module)">Result</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Err</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>Class: Mangrove::Result::Err
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">Mangrove::Result::Err</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
<dl>
|
|
89
|
+
<dt>Extended by:</dt>
|
|
90
|
+
<dd>T::Generic, T::Helpers, T::Sig</dd>
|
|
91
|
+
</dl>
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Includes:</dt>
|
|
97
|
+
<dd><span class='object_link'><a href="../Result.html" title="Mangrove::Result (module)">Mangrove::Result</a></span></dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
<dl>
|
|
106
|
+
<dt>Defined in:</dt>
|
|
107
|
+
<dd>lib/mangrove/result.rb</dd>
|
|
108
|
+
</dl>
|
|
109
|
+
|
|
110
|
+
</div>
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
<h2>
|
|
115
|
+
Constant Summary
|
|
116
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
117
|
+
</h2>
|
|
118
|
+
|
|
119
|
+
<dl class="constants">
|
|
120
|
+
|
|
121
|
+
<dt id="OkType-constant" class="">OkType =
|
|
122
|
+
|
|
123
|
+
</dt>
|
|
124
|
+
<dd><pre class="code"><span class='id identifier rubyid_type_member'>type_member</span></pre></dd>
|
|
125
|
+
|
|
126
|
+
<dt id="ErrType-constant" class="">ErrType =
|
|
127
|
+
|
|
128
|
+
</dt>
|
|
129
|
+
<dd><pre class="code"><span class='id identifier rubyid_type_member'>type_member</span></pre></dd>
|
|
130
|
+
|
|
131
|
+
</dl>
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
<h2>
|
|
142
|
+
Instance Method Summary
|
|
143
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
144
|
+
</h2>
|
|
145
|
+
|
|
146
|
+
<ul class="summary">
|
|
147
|
+
|
|
148
|
+
<li class="public ">
|
|
149
|
+
<span class="summary_signature">
|
|
150
|
+
|
|
151
|
+
<a href="#==-instance_method" title="#== (instance method)">#<strong>==</strong>(other) ⇒ Boolean </a>
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
</span>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
166
|
+
|
|
167
|
+
</li>
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
<li class="public ">
|
|
171
|
+
<span class="summary_signature">
|
|
172
|
+
|
|
173
|
+
<a href="#err%3F-instance_method" title="#err? (instance method)">#<strong>err?</strong> ⇒ Boolean </a>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
</span>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
188
|
+
|
|
189
|
+
</li>
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
<li class="public ">
|
|
193
|
+
<span class="summary_signature">
|
|
194
|
+
|
|
195
|
+
<a href="#err_inner-instance_method" title="#err_inner (instance method)">#<strong>err_inner</strong> ⇒ ErrType </a>
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
</span>
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
210
|
+
|
|
211
|
+
</li>
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
<li class="public ">
|
|
215
|
+
<span class="summary_signature">
|
|
216
|
+
|
|
217
|
+
<a href="#expect!-instance_method" title="#expect! (instance method)">#<strong>expect!</strong>(message) ⇒ OkType </a>
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
</span>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
232
|
+
|
|
233
|
+
</li>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
<li class="public ">
|
|
237
|
+
<span class="summary_signature">
|
|
238
|
+
|
|
239
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(inner) ⇒ void </a>
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
</span>
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
<span class="note title constructor">constructor</span>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
256
|
+
|
|
257
|
+
</li>
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
<li class="public ">
|
|
261
|
+
<span class="summary_signature">
|
|
262
|
+
|
|
263
|
+
<a href="#map_err-instance_method" title="#map_err (instance method)">#<strong>map_err</strong>(&block) ⇒ Result[OkType, ErrType] </a>
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
</span>
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
278
|
+
|
|
279
|
+
</li>
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
<li class="public ">
|
|
283
|
+
<span class="summary_signature">
|
|
284
|
+
|
|
285
|
+
<a href="#map_ok-instance_method" title="#map_ok (instance method)">#<strong>map_ok</strong>(&_block) ⇒ Result[OkType, ErrType] </a>
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
</span>
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
300
|
+
|
|
301
|
+
</li>
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
<li class="public ">
|
|
305
|
+
<span class="summary_signature">
|
|
306
|
+
|
|
307
|
+
<a href="#ok%3F-instance_method" title="#ok? (instance method)">#<strong>ok?</strong> ⇒ Boolean </a>
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
</span>
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
322
|
+
|
|
323
|
+
</li>
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
<li class="public ">
|
|
327
|
+
<span class="summary_signature">
|
|
328
|
+
|
|
329
|
+
<a href="#unwrap!-instance_method" title="#unwrap! (instance method)">#<strong>unwrap!</strong> ⇒ OkType </a>
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
</span>
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
344
|
+
|
|
345
|
+
</li>
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
</ul>
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="../Result.html" title="Mangrove::Result (module)">Mangrove::Result</a></span></h3>
|
|
364
|
+
<p class="inherited"><span class='object_link'><a href="../Result.html#from_results-class_method" title="Mangrove::Result.from_results (method)">from_results</a></span></p>
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
<div id="constructor_details" class="method_details_list">
|
|
370
|
+
<h2>Constructor Details</h2>
|
|
371
|
+
|
|
372
|
+
<div class="method_details first">
|
|
373
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
374
|
+
|
|
375
|
+
#<strong>initialize</strong>(inner) ⇒ <tt>void</tt>
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
</h3><div class="docstring">
|
|
382
|
+
<div class="discussion">
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
</div>
|
|
386
|
+
</div>
|
|
387
|
+
<div class="tags">
|
|
388
|
+
<p class="tag_title">Parameters:</p>
|
|
389
|
+
<ul class="param">
|
|
390
|
+
|
|
391
|
+
<li>
|
|
392
|
+
|
|
393
|
+
<span class='name'>inner</span>
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
<span class='type'>(<tt><span class='object_link'><a href="#ErrType-constant" title="Mangrove::Result::Err::ErrType (constant)">ErrType</a></span></tt>)</span>
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
</li>
|
|
401
|
+
|
|
402
|
+
</ul>
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
</div><table class="source_code">
|
|
406
|
+
<tr>
|
|
407
|
+
<td>
|
|
408
|
+
<pre class="lines">
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
133
|
|
412
|
+
134
|
|
413
|
+
135</pre>
|
|
414
|
+
</td>
|
|
415
|
+
<td>
|
|
416
|
+
<pre class="code"><span class="info file"># File 'lib/mangrove/result.rb', line 133</span>
|
|
417
|
+
|
|
418
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_inner'>inner</span><span class='rparen'>)</span>
|
|
419
|
+
<span class='ivar'>@inner</span> <span class='op'>=</span> <span class='id identifier rubyid_inner'>inner</span>
|
|
420
|
+
<span class='kw'>end</span></pre>
|
|
421
|
+
</td>
|
|
422
|
+
</tr>
|
|
423
|
+
</table>
|
|
424
|
+
</div>
|
|
425
|
+
|
|
426
|
+
</div>
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
<div id="instance_method_details" class="method_details_list">
|
|
430
|
+
<h2>Instance Method Details</h2>
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
<div class="method_details first">
|
|
434
|
+
<h3 class="signature first" id="==-instance_method">
|
|
435
|
+
|
|
436
|
+
#<strong>==</strong>(other) ⇒ <tt>Boolean</tt>
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
</h3><div class="docstring">
|
|
443
|
+
<div class="discussion">
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
</div>
|
|
447
|
+
</div>
|
|
448
|
+
<div class="tags">
|
|
449
|
+
<p class="tag_title">Parameters:</p>
|
|
450
|
+
<ul class="param">
|
|
451
|
+
|
|
452
|
+
<li>
|
|
453
|
+
|
|
454
|
+
<span class='name'>other</span>
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
<span class='type'>(<tt>BasicObject</tt>)</span>
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
</li>
|
|
462
|
+
|
|
463
|
+
</ul>
|
|
464
|
+
|
|
465
|
+
<p class="tag_title">Returns:</p>
|
|
466
|
+
<ul class="return">
|
|
467
|
+
|
|
468
|
+
<li>
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
</li>
|
|
476
|
+
|
|
477
|
+
</ul>
|
|
478
|
+
|
|
479
|
+
</div><table class="source_code">
|
|
480
|
+
<tr>
|
|
481
|
+
<td>
|
|
482
|
+
<pre class="lines">
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
138
|
|
486
|
+
139
|
|
487
|
+
140
|
|
488
|
+
141
|
|
489
|
+
142
|
|
490
|
+
143
|
|
491
|
+
144
|
|
492
|
+
145
|
|
493
|
+
146
|
|
494
|
+
147</pre>
|
|
495
|
+
</td>
|
|
496
|
+
<td>
|
|
497
|
+
<pre class="code"><span class="info file"># File 'lib/mangrove/result.rb', line 138</span>
|
|
498
|
+
|
|
499
|
+
<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>
|
|
500
|
+
<span class='kw'>case</span> <span class='id identifier rubyid_other'>other</span>
|
|
501
|
+
<span class='kw'>when</span> <span class='const'><span class='object_link'><a href="../Result.html" title="Mangrove::Result (module)">Result</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Ok.html" title="Mangrove::Result::Ok (class)">Ok</a></span></span>
|
|
502
|
+
<span class='kw'>false</span>
|
|
503
|
+
<span class='kw'>when</span> <span class='const'><span class='object_link'><a href="../Result.html" title="Mangrove::Result (module)">Result</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Mangrove::Result::Err (class)">Err</a></span></span>
|
|
504
|
+
<span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_instance_variable_get'>instance_variable_get</span><span class='lparen'>(</span><span class='symbol'>:@inner</span><span class='rparen'>)</span> <span class='op'>==</span> <span class='ivar'>@inner</span>
|
|
505
|
+
<span class='kw'>else</span>
|
|
506
|
+
<span class='kw'>false</span>
|
|
507
|
+
<span class='kw'>end</span>
|
|
508
|
+
<span class='kw'>end</span></pre>
|
|
509
|
+
</td>
|
|
510
|
+
</tr>
|
|
511
|
+
</table>
|
|
512
|
+
</div>
|
|
513
|
+
|
|
514
|
+
<div class="method_details ">
|
|
515
|
+
<h3 class="signature " id="err?-instance_method">
|
|
516
|
+
|
|
517
|
+
#<strong>err?</strong> ⇒ <tt>Boolean</tt>
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
</h3><div class="docstring">
|
|
524
|
+
<div class="discussion">
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
</div>
|
|
528
|
+
</div>
|
|
529
|
+
<div class="tags">
|
|
530
|
+
|
|
531
|
+
<p class="tag_title">Returns:</p>
|
|
532
|
+
<ul class="return">
|
|
533
|
+
|
|
534
|
+
<li>
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
</li>
|
|
542
|
+
|
|
543
|
+
</ul>
|
|
544
|
+
|
|
545
|
+
</div><table class="source_code">
|
|
546
|
+
<tr>
|
|
547
|
+
<td>
|
|
548
|
+
<pre class="lines">
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
168</pre>
|
|
552
|
+
</td>
|
|
553
|
+
<td>
|
|
554
|
+
<pre class="code"><span class="info file"># File 'lib/mangrove/result.rb', line 168</span>
|
|
555
|
+
|
|
556
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_err?'>err?</span> <span class='op'>=</span> <span class='kw'>true</span></pre>
|
|
557
|
+
</td>
|
|
558
|
+
</tr>
|
|
559
|
+
</table>
|
|
560
|
+
</div>
|
|
561
|
+
|
|
562
|
+
<div class="method_details ">
|
|
563
|
+
<h3 class="signature " id="err_inner-instance_method">
|
|
564
|
+
|
|
565
|
+
#<strong>err_inner</strong> ⇒ <tt><span class='object_link'><a href="#ErrType-constant" title="Mangrove::Result::Err::ErrType (constant)">ErrType</a></span></tt>
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
</h3><div class="docstring">
|
|
572
|
+
<div class="discussion">
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
</div>
|
|
576
|
+
</div>
|
|
577
|
+
<div class="tags">
|
|
578
|
+
|
|
579
|
+
<p class="tag_title">Returns:</p>
|
|
580
|
+
<ul class="return">
|
|
581
|
+
|
|
582
|
+
<li>
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
<span class='type'>(<tt><span class='object_link'><a href="#ErrType-constant" title="Mangrove::Result::Err::ErrType (constant)">ErrType</a></span></tt>)</span>
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
</li>
|
|
590
|
+
|
|
591
|
+
</ul>
|
|
592
|
+
|
|
593
|
+
</div><table class="source_code">
|
|
594
|
+
<tr>
|
|
595
|
+
<td>
|
|
596
|
+
<pre class="lines">
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
150
|
|
600
|
+
151
|
|
601
|
+
152</pre>
|
|
602
|
+
</td>
|
|
603
|
+
<td>
|
|
604
|
+
<pre class="code"><span class="info file"># File 'lib/mangrove/result.rb', line 150</span>
|
|
605
|
+
|
|
606
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_err_inner'>err_inner</span>
|
|
607
|
+
<span class='ivar'>@inner</span>
|
|
608
|
+
<span class='kw'>end</span></pre>
|
|
609
|
+
</td>
|
|
610
|
+
</tr>
|
|
611
|
+
</table>
|
|
612
|
+
</div>
|
|
613
|
+
|
|
614
|
+
<div class="method_details ">
|
|
615
|
+
<h3 class="signature " id="expect!-instance_method">
|
|
616
|
+
|
|
617
|
+
#<strong>expect!</strong>(message) ⇒ <tt><span class='object_link'><a href="#OkType-constant" title="Mangrove::Result::Err::OkType (constant)">OkType</a></span></tt>
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
</h3><div class="docstring">
|
|
624
|
+
<div class="discussion">
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
</div>
|
|
628
|
+
</div>
|
|
629
|
+
<div class="tags">
|
|
630
|
+
<p class="tag_title">Parameters:</p>
|
|
631
|
+
<ul class="param">
|
|
632
|
+
|
|
633
|
+
<li>
|
|
634
|
+
|
|
635
|
+
<span class='name'>message</span>
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
</li>
|
|
643
|
+
|
|
644
|
+
</ul>
|
|
645
|
+
|
|
646
|
+
<p class="tag_title">Returns:</p>
|
|
647
|
+
<ul class="return">
|
|
648
|
+
|
|
649
|
+
<li>
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
<span class='type'>(<tt><span class='object_link'><a href="#OkType-constant" title="Mangrove::Result::Err::OkType (constant)">OkType</a></span></tt>)</span>
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
</li>
|
|
657
|
+
|
|
658
|
+
</ul>
|
|
659
|
+
<p class="tag_title">Raises:</p>
|
|
660
|
+
<ul class="raise">
|
|
661
|
+
|
|
662
|
+
<li>
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
<span class='type'>(<tt><span class='object_link'><a href="ControlSignal.html" title="Mangrove::Result::ControlSignal (class)">Result::ControlSignal</a></span></tt>)</span>
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
</li>
|
|
670
|
+
|
|
671
|
+
</ul>
|
|
672
|
+
|
|
673
|
+
</div><table class="source_code">
|
|
674
|
+
<tr>
|
|
675
|
+
<td>
|
|
676
|
+
<pre class="lines">
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
160
|
|
680
|
+
161
|
|
681
|
+
162</pre>
|
|
682
|
+
</td>
|
|
683
|
+
<td>
|
|
684
|
+
<pre class="code"><span class="info file"># File 'lib/mangrove/result.rb', line 160</span>
|
|
685
|
+
|
|
686
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_expect!'>expect!</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
|
|
687
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../Result.html" title="Mangrove::Result (module)">Result</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ControlSignal.html" title="Mangrove::Result::ControlSignal (class)">ControlSignal</a></span></span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span>
|
|
688
|
+
<span class='kw'>end</span></pre>
|
|
689
|
+
</td>
|
|
690
|
+
</tr>
|
|
691
|
+
</table>
|
|
692
|
+
</div>
|
|
693
|
+
|
|
694
|
+
<div class="method_details ">
|
|
695
|
+
<h3 class="signature " id="map_err-instance_method">
|
|
696
|
+
|
|
697
|
+
#<strong>map_err</strong>(&block) ⇒ <tt><span class='object_link'><a href="../Result.html" title="Mangrove::Result (module)">Result</a></span>[<span class='object_link'><a href="#OkType-constant" title="Mangrove::Result::Err::OkType (constant)">OkType</a></span>, <span class='object_link'><a href="#ErrType-constant" title="Mangrove::Result::Err::ErrType (constant)">ErrType</a></span>]</tt>
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
</h3><div class="docstring">
|
|
704
|
+
<div class="discussion">
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
</div>
|
|
708
|
+
</div>
|
|
709
|
+
<div class="tags">
|
|
710
|
+
<p class="tag_title">Parameters:</p>
|
|
711
|
+
<ul class="param">
|
|
712
|
+
|
|
713
|
+
<li>
|
|
714
|
+
|
|
715
|
+
<span class='name'>block</span>
|
|
716
|
+
|
|
717
|
+
|
|
718
|
+
<span class='type'>(<tt>T.proc.params(this: <span class='object_link'><a href="#ErrType-constant" title="Mangrove::Result::Err::ErrType (constant)">ErrType</a></span>).returns(<span class='object_link'><a href="../Result.html" title="Mangrove::Result (module)">Result</a></span>[<span class='object_link'><a href="#OkType-constant" title="Mangrove::Result::Err::OkType (constant)">OkType</a></span>, <span class='object_link'><a href="#ErrType-constant" title="Mangrove::Result::Err::ErrType (constant)">ErrType</a></span>])</tt>)</span>
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
</li>
|
|
723
|
+
|
|
724
|
+
</ul>
|
|
725
|
+
|
|
726
|
+
<p class="tag_title">Returns:</p>
|
|
727
|
+
<ul class="return">
|
|
728
|
+
|
|
729
|
+
<li>
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Result.html" title="Mangrove::Result (module)">Result</a></span>[<span class='object_link'><a href="#OkType-constant" title="Mangrove::Result::Err::OkType (constant)">OkType</a></span>, <span class='object_link'><a href="#ErrType-constant" title="Mangrove::Result::Err::ErrType (constant)">ErrType</a></span>]</tt>)</span>
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
</li>
|
|
737
|
+
|
|
738
|
+
</ul>
|
|
739
|
+
|
|
740
|
+
</div><table class="source_code">
|
|
741
|
+
<tr>
|
|
742
|
+
<td>
|
|
743
|
+
<pre class="lines">
|
|
744
|
+
|
|
745
|
+
|
|
746
|
+
176
|
|
747
|
+
177
|
|
748
|
+
178</pre>
|
|
749
|
+
</td>
|
|
750
|
+
<td>
|
|
751
|
+
<pre class="code"><span class="info file"># File 'lib/mangrove/result.rb', line 176</span>
|
|
752
|
+
|
|
753
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_map_err'>map_err</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
754
|
+
<span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='ivar'>@inner</span><span class='rparen'>)</span>
|
|
755
|
+
<span class='kw'>end</span></pre>
|
|
756
|
+
</td>
|
|
757
|
+
</tr>
|
|
758
|
+
</table>
|
|
759
|
+
</div>
|
|
760
|
+
|
|
761
|
+
<div class="method_details ">
|
|
762
|
+
<h3 class="signature " id="map_ok-instance_method">
|
|
763
|
+
|
|
764
|
+
#<strong>map_ok</strong>(&_block) ⇒ <tt><span class='object_link'><a href="../Result.html" title="Mangrove::Result (module)">Result</a></span>[<span class='object_link'><a href="#OkType-constant" title="Mangrove::Result::Err::OkType (constant)">OkType</a></span>, <span class='object_link'><a href="#ErrType-constant" title="Mangrove::Result::Err::ErrType (constant)">ErrType</a></span>]</tt>
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
</h3><div class="docstring">
|
|
771
|
+
<div class="discussion">
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
</div>
|
|
775
|
+
</div>
|
|
776
|
+
<div class="tags">
|
|
777
|
+
<p class="tag_title">Parameters:</p>
|
|
778
|
+
<ul class="param">
|
|
779
|
+
|
|
780
|
+
<li>
|
|
781
|
+
|
|
782
|
+
<span class='name'>_block</span>
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
<span class='type'>(<tt>T.proc.params(this: <span class='object_link'><a href="#OkType-constant" title="Mangrove::Result::Err::OkType (constant)">OkType</a></span>).returns(<span class='object_link'><a href="../Result.html" title="Mangrove::Result (module)">Result</a></span>[<span class='object_link'><a href="#OkType-constant" title="Mangrove::Result::Err::OkType (constant)">OkType</a></span>, <span class='object_link'><a href="#ErrType-constant" title="Mangrove::Result::Err::ErrType (constant)">ErrType</a></span>])</tt>)</span>
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
</li>
|
|
790
|
+
|
|
791
|
+
</ul>
|
|
792
|
+
|
|
793
|
+
<p class="tag_title">Returns:</p>
|
|
794
|
+
<ul class="return">
|
|
795
|
+
|
|
796
|
+
<li>
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Result.html" title="Mangrove::Result (module)">Result</a></span>[<span class='object_link'><a href="#OkType-constant" title="Mangrove::Result::Err::OkType (constant)">OkType</a></span>, <span class='object_link'><a href="#ErrType-constant" title="Mangrove::Result::Err::ErrType (constant)">ErrType</a></span>]</tt>)</span>
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
</li>
|
|
804
|
+
|
|
805
|
+
</ul>
|
|
806
|
+
|
|
807
|
+
</div><table class="source_code">
|
|
808
|
+
<tr>
|
|
809
|
+
<td>
|
|
810
|
+
<pre class="lines">
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
171
|
|
814
|
+
172
|
|
815
|
+
173</pre>
|
|
816
|
+
</td>
|
|
817
|
+
<td>
|
|
818
|
+
<pre class="code"><span class="info file"># File 'lib/mangrove/result.rb', line 171</span>
|
|
819
|
+
|
|
820
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_map_ok'>map_ok</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid__block'>_block</span><span class='rparen'>)</span>
|
|
821
|
+
<span class='kw'>self</span>
|
|
822
|
+
<span class='kw'>end</span></pre>
|
|
823
|
+
</td>
|
|
824
|
+
</tr>
|
|
825
|
+
</table>
|
|
826
|
+
</div>
|
|
827
|
+
|
|
828
|
+
<div class="method_details ">
|
|
829
|
+
<h3 class="signature " id="ok?-instance_method">
|
|
830
|
+
|
|
831
|
+
#<strong>ok?</strong> ⇒ <tt>Boolean</tt>
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
</h3><div class="docstring">
|
|
838
|
+
<div class="discussion">
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
</div>
|
|
842
|
+
</div>
|
|
843
|
+
<div class="tags">
|
|
844
|
+
|
|
845
|
+
<p class="tag_title">Returns:</p>
|
|
846
|
+
<ul class="return">
|
|
847
|
+
|
|
848
|
+
<li>
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
</li>
|
|
856
|
+
|
|
857
|
+
</ul>
|
|
858
|
+
|
|
859
|
+
</div><table class="source_code">
|
|
860
|
+
<tr>
|
|
861
|
+
<td>
|
|
862
|
+
<pre class="lines">
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
165</pre>
|
|
866
|
+
</td>
|
|
867
|
+
<td>
|
|
868
|
+
<pre class="code"><span class="info file"># File 'lib/mangrove/result.rb', line 165</span>
|
|
869
|
+
|
|
870
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_ok?'>ok?</span> <span class='op'>=</span> <span class='kw'>false</span></pre>
|
|
871
|
+
</td>
|
|
872
|
+
</tr>
|
|
873
|
+
</table>
|
|
874
|
+
</div>
|
|
875
|
+
|
|
876
|
+
<div class="method_details ">
|
|
877
|
+
<h3 class="signature " id="unwrap!-instance_method">
|
|
878
|
+
|
|
879
|
+
#<strong>unwrap!</strong> ⇒ <tt><span class='object_link'><a href="#OkType-constant" title="Mangrove::Result::Err::OkType (constant)">OkType</a></span></tt>
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
</h3><div class="docstring">
|
|
886
|
+
<div class="discussion">
|
|
887
|
+
|
|
888
|
+
|
|
889
|
+
</div>
|
|
890
|
+
</div>
|
|
891
|
+
<div class="tags">
|
|
892
|
+
|
|
893
|
+
<p class="tag_title">Returns:</p>
|
|
894
|
+
<ul class="return">
|
|
895
|
+
|
|
896
|
+
<li>
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
<span class='type'>(<tt><span class='object_link'><a href="#OkType-constant" title="Mangrove::Result::Err::OkType (constant)">OkType</a></span></tt>)</span>
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
</li>
|
|
904
|
+
|
|
905
|
+
</ul>
|
|
906
|
+
<p class="tag_title">Raises:</p>
|
|
907
|
+
<ul class="raise">
|
|
908
|
+
|
|
909
|
+
<li>
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
<span class='type'>(<tt><span class='object_link'><a href="ControlSignal.html" title="Mangrove::Result::ControlSignal (class)">Result::ControlSignal</a></span></tt>)</span>
|
|
913
|
+
|
|
914
|
+
|
|
915
|
+
|
|
916
|
+
</li>
|
|
917
|
+
|
|
918
|
+
</ul>
|
|
919
|
+
|
|
920
|
+
</div><table class="source_code">
|
|
921
|
+
<tr>
|
|
922
|
+
<td>
|
|
923
|
+
<pre class="lines">
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
155
|
|
927
|
+
156
|
|
928
|
+
157</pre>
|
|
929
|
+
</td>
|
|
930
|
+
<td>
|
|
931
|
+
<pre class="code"><span class="info file"># File 'lib/mangrove/result.rb', line 155</span>
|
|
932
|
+
|
|
933
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_unwrap!'>unwrap!</span>
|
|
934
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../Result.html" title="Mangrove::Result (module)">Result</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ControlSignal.html" title="Mangrove::Result::ControlSignal (class)">ControlSignal</a></span></span><span class='comma'>,</span> <span class='ivar'>@inner</span>
|
|
935
|
+
<span class='kw'>end</span></pre>
|
|
936
|
+
</td>
|
|
937
|
+
</tr>
|
|
938
|
+
</table>
|
|
939
|
+
</div>
|
|
940
|
+
|
|
941
|
+
</div>
|
|
942
|
+
|
|
943
|
+
</div>
|
|
944
|
+
|
|
945
|
+
<div id="footer">
|
|
946
|
+
Generated on Fri Sep 1 17:32:57 2023 by
|
|
947
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
948
|
+
0.9.34 (ruby-3.2.2).
|
|
949
|
+
</div>
|
|
950
|
+
|
|
951
|
+
</div>
|
|
952
|
+
</body>
|
|
953
|
+
</html>
|