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