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