forked from rescript-lang/rescript
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathBelt.Result.html
302 lines (253 loc) · 16.5 KB
/
Belt.Result.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
<!doctype html>
<html>
<head>
<link rel="stylesheet" href="../api_static/tomorrow-night.css">
<link rel="stylesheet" href="../api_static/style.css" type="text/css">
<script src="../api_static//highlight.pack.js"></script>
<script src="../api_static//script.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<meta charset="utf8">
<link rel="previous" href="Belt.Option.html"><link rel="next" href="Belt.Debug.html">
<title> Belt.Result </title></head>
<body>
<nav class="module-index"><ul><li><a href="Belt.html">Belt</a></li>
<li><a href="Belt_Array.html">Belt_Array</a></li>
<li><a href="Belt_Debug.html">Belt_Debug</a></li>
<li><a href="Belt_HashMap.html">Belt_HashMap</a></li>
<li><a href="Belt_HashMapInt.html">Belt_HashMapInt</a></li>
<li><a href="Belt_HashMapString.html">Belt_HashMapString</a></li>
<li><a href="Belt_HashSet.html">Belt_HashSet</a></li>
<li><a href="Belt_HashSetInt.html">Belt_HashSetInt</a></li>
<li><a href="Belt_HashSetString.html">Belt_HashSetString</a></li>
<li><a href="Belt_Id.html">Belt_Id</a></li>
<li><a href="Belt_List.html">Belt_List</a></li>
<li><a href="Belt_Map.html">Belt_Map</a></li>
<li><a href="Belt_MapDict.html">Belt_MapDict</a></li>
<li><a href="Belt_MapInt.html">Belt_MapInt</a></li>
<li><a href="Belt_MapString.html">Belt_MapString</a></li>
<li><a href="Belt_MutableMap.html">Belt_MutableMap</a></li>
<li><a href="Belt_MutableMapInt.html">Belt_MutableMapInt</a></li>
<li><a href="Belt_MutableMapString.html">Belt_MutableMapString</a></li>
<li><a href="Belt_MutableQueue.html">Belt_MutableQueue</a></li>
<li><a href="Belt_MutableSet.html">Belt_MutableSet</a></li>
<li><a href="Belt_MutableSetInt.html">Belt_MutableSetInt</a></li>
<li><a href="Belt_MutableSetString.html">Belt_MutableSetString</a></li>
<li><a href="Belt_MutableStack.html">Belt_MutableStack</a></li>
<li><a href="Belt_Option.html">Belt_Option</a></li>
<li><a href="Belt_Range.html">Belt_Range</a></li>
<li><a href="Belt_Result.html">Belt_Result</a></li>
<li><a href="Belt_Set.html">Belt_Set</a></li>
<li><a href="Belt_SetDict.html">Belt_SetDict</a></li>
<li><a href="Belt_SetInt.html">Belt_SetInt</a></li>
<li><a href="Belt_SetString.html">Belt_SetString</a></li>
<li><a href="Belt_SortArray.html">Belt_SortArray</a></li>
<li><a href="Belt_SortArrayInt.html">Belt_SortArrayInt</a></li>
<li><a href="Belt_SortArrayString.html">Belt_SortArrayString</a></li>
<li><a href="Belt_internalAVLset.html">Belt_internalAVLset</a></li>
<li><a href="Belt_internalAVLtree.html">Belt_internalAVLtree</a></li>
<li><a href="Belt_internalBuckets.html">Belt_internalBuckets</a></li>
<li><a href="Belt_internalBucketsType.html">Belt_internalBucketsType</a></li>
<li><a href="Belt_internalMapInt.html">Belt_internalMapInt</a></li>
<li><a href="Belt_internalMapString.html">Belt_internalMapString</a></li>
<li><a href="Belt_internalMutableAVLMap.html">Belt_internalMutableAVLMap</a></li>
<li><a href="Belt_internalSetBuckets.html">Belt_internalSetBuckets</a></li>
<li><a href="Belt_internalSetInt.html">Belt_internalSetInt</a></li>
<li><a href="Belt_internalSetString.html">Belt_internalSetString</a></li>
<li><a href="Dom.html">Dom</a></li>
<li><a href="Dom_storage.html">Dom_storage</a></li>
<li><a href="Js.html">Js</a></li>
<li><a href="Js_array.html">Js_array</a></li>
<li><a href="Js_cast.html">Js_cast</a></li>
<li><a href="Js_console.html">Js_console</a></li>
<li><a href="Js_date.html">Js_date</a></li>
<li><a href="Js_dict.html">Js_dict</a></li>
<li><a href="Js_exn.html">Js_exn</a></li>
<li><a href="Js_float.html">Js_float</a></li>
<li><a href="Js_global.html">Js_global</a></li>
<li><a href="Js_int.html">Js_int</a></li>
<li><a href="Js_json.html">Js_json</a></li>
<li><a href="Js_list.html">Js_list</a></li>
<li><a href="Js_mapperRt.html">Js_mapperRt</a></li>
<li><a href="Js_math.html">Js_math</a></li>
<li><a href="Js_null.html">Js_null</a></li>
<li><a href="Js_null_undefined.html">Js_null_undefined</a></li>
<li><a href="Js_obj.html">Js_obj</a></li>
<li><a href="Js_option.html">Js_option</a></li>
<li><a href="Js_promise.html">Js_promise</a></li>
<li><a href="Js_re.html">Js_re</a></li>
<li><a href="Js_result.html">Js_result</a></li>
<li><a href="Js_string.html">Js_string</a></li>
<li><a href="Js_typed_array.html">Js_typed_array</a></li>
<li><a href="Js_types.html">Js_types</a></li>
<li><a href="Js_undefined.html">Js_undefined</a></li>
<li><a href="Js_vector.html">Js_vector</a></li>
<li><a href="Node.html">Node</a></li>
<li><a href="Node_buffer.html">Node_buffer</a></li>
<li><a href="Node_child_process.html">Node_child_process</a></li>
<li><a href="Node_fs.html">Node_fs</a></li>
<li><a href="Node_module.html">Node_module</a></li>
<li><a href="Node_path.html">Node_path</a></li>
<li><a href="Node_process.html">Node_process</a></li></ul></nav>
<div class="navbar"><a class="pre" href="Belt.Option.html" title="Belt.Option">Previous</a>
<a class="up" href="Belt.html" title="Belt">Up</a>
<a class="post" href="Belt.Debug.html" title="Belt.Debug">Next</a>
</div>
<h1>Module <a href="type_Belt.Result.html">Belt.Result</a></h1>
<pre><span class="keyword">module</span> Result: <code class="type"><a href="Belt_Result.html">Belt_Result</a></code></pre><hr width="100%">
<div class="type-declaration">
<pre><code><span id="TYPEt"><span class="keyword">type</span> <code class="type">('a, 'b)</code> t</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.Ok"><span class="constructor">Ok</span></span></td><td><span class="keyword">of</span></td><td><code class="type">'a</code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.Error"><span class="constructor">Error</span></span></td><td><span class="keyword">of</span></td><td><code class="type">'b</code></code></td>
</tr></table>
</div>
<pre><span id="VALgetExn"><span class="keyword">val</span> getExn</span> : <code class="type">('a, 'b) <a href="Belt_Result.html#TYPEt">t</a> -> 'a</code></pre><div class="info ">
<div class="not-examples">
<code class="code">getExn res</code>
<p>
when <code class="code">res</code> is <code class="code">Ok n</code>, returns <code class="code">n</code>
when <code class="code">res</code> is <code class="code">Error m</code>, <b>raise</b> an exception<br>
</div>
<div class="examples">
<pre class="example"> <pre class="codepre"><code class="code"> getExn good = 42
getExn bad (* raises exception *)
</code></pre> </pre>
</div>
</div>
<pre><span id="VALmapWithDefaultU"><span class="keyword">val</span> mapWithDefaultU</span> : <code class="type">('a, 'c) <a href="Belt_Result.html#TYPEt">t</a> -> 'b -> ('a -> 'b [@bs]) -> 'b</code></pre>
<pre><span id="VALmapWithDefault"><span class="keyword">val</span> mapWithDefault</span> : <code class="type">('a, 'c) <a href="Belt_Result.html#TYPEt">t</a> -> 'b -> ('a -> 'b) -> 'b</code></pre><div class="info ">
<div class="not-examples">
<code class="code">mapWithDefault res default f</code>
<p>
When <code class="code">res</code> is <code class="code">Ok n</code>, returns <code class="code">f n</code>, otherwise <code class="code">default</code>.<br>
</div>
<div class="examples">
<pre class="example"> <pre class="codepre"><code class="code"> mapWithDefault good 0 (function x -> x / 2) = 21
mapWithDefault bad 0 (function x -> x / 2) = 0
</code></pre> </pre>
</div>
</div>
<pre><span id="VALmapU"><span class="keyword">val</span> mapU</span> : <code class="type">('a, 'c) <a href="Belt_Result.html#TYPEt">t</a> -> ('a -> 'b [@bs]) -> ('b, 'c) <a href="Belt_Result.html#TYPEt">t</a></code></pre>
<pre><span id="VALmap"><span class="keyword">val</span> map</span> : <code class="type">('a, 'c) <a href="Belt_Result.html#TYPEt">t</a> -> ('a -> 'b) -> ('b, 'c) <a href="Belt_Result.html#TYPEt">t</a></code></pre><div class="info ">
<div class="not-examples">
<code class="code">map res f</code>
<p>
When <code class="code">res</code> is <code class="code">Ok n</code>, returns <code class="code">Ok (f n)</code>. Otherwise returns <code class="code">res</code> unchanged.
Function <code class="code">f</code> takes a value of the same type as <code class="code">n</code> and returns an ordinary value.<br>
</div>
<div class="examples">
<pre class="example"> <pre class="codepre"><code class="code"> let f x = sqrt (float_of_int x)
map (Ok 64) f = Ok 8.0
map (Error "Invalid data") f = Error "Invalid data"
</code></pre> </pre>
</div>
</div>
<pre><span id="VALflatMapU"><span class="keyword">val</span> flatMapU</span> : <code class="type">('a, 'c) <a href="Belt_Result.html#TYPEt">t</a> -><br> ('a -> ('b, 'c) <a href="Belt_Result.html#TYPEt">t</a> [@bs]) -> ('b, 'c) <a href="Belt_Result.html#TYPEt">t</a></code></pre>
<pre><span id="VALflatMap"><span class="keyword">val</span> flatMap</span> : <code class="type">('a, 'c) <a href="Belt_Result.html#TYPEt">t</a> -><br> ('a -> ('b, 'c) <a href="Belt_Result.html#TYPEt">t</a>) -> ('b, 'c) <a href="Belt_Result.html#TYPEt">t</a></code></pre><div class="info ">
<div class="not-examples">
<code class="code">flatMap res f</code>
<p>
When <code class="code">res</code> is <code class="code">Ok n</code>, returns <code class="code">f n</code>. Otherwise, returns <code class="code">res</code> unchanged.
Function <code class="code">f</code> takes a value of the same type as <code class="code">n</code> and returns a <code class="code">Belt.Result</code>.<br>
</div>
<div class="examples">
<pre class="example"> <pre class="codepre"><code class="code">let recip x =
if x != 0.0
then
Ok (1.0 /. x)
else
Error "Divide by zero"
flatMap (Ok 2.0) recip = Ok 0.5
flatMap (Ok 0.0) recip = Error "Divide by zero"
flatMap (Error "Already bad") recip = Error "Already bad"
</code></pre> </pre>
</div>
</div>
<pre><span id="VALgetWithDefault"><span class="keyword">val</span> getWithDefault</span> : <code class="type">('a, 'b) <a href="Belt_Result.html#TYPEt">t</a> -> 'a -> 'a</code></pre><div class="info ">
<div class="not-examples">
<code class="code">getWithDefault res defaultValue</code>
<p>
if <code class="code">res</code> is <code class="code">Ok n</code>, returns <code class="code">n</code>, otherwise <code class="code">default</code><br>
</div>
<div class="examples">
<pre class="example"> <pre class="codepre"><code class="code"> getWithDefault (Ok 42) 0 = 42
getWithDefault (Error "Invalid Data") = 0
</code></pre> </pre>
</div>
</div>
<pre><span id="VALisOk"><span class="keyword">val</span> isOk</span> : <code class="type">('a, 'b) <a href="Belt_Result.html#TYPEt">t</a> -> bool</code></pre><div class="info ">
<div class="not-examples">
<code class="code">isOk res</code>
<p>
Returns <code class="code">true</code> if <code class="code">res</code> is of the form <code class="code">Ok n</code>, <code class="code">false</code> if it is the <code class="code">Error e</code> variant.<br>
</div>
</div>
<pre><span id="VALisError"><span class="keyword">val</span> isError</span> : <code class="type">('a, 'b) <a href="Belt_Result.html#TYPEt">t</a> -> bool</code></pre><div class="info ">
<div class="not-examples">
<code class="code">isError res</code>
<p>
Returns <code class="code">true</code> if <code class="code">res</code> is of the form <code class="code">Error e</code>, <code class="code">false</code> if it is the <code class="code">Ok n</code> variant.<br>
</div>
</div>
<pre><span id="VALeqU"><span class="keyword">val</span> eqU</span> : <code class="type">('a, 'c) <a href="Belt_Result.html#TYPEt">t</a> -><br> ('b, 'd) <a href="Belt_Result.html#TYPEt">t</a> -> ('a -> 'b -> bool [@bs]) -> bool</code></pre>
<pre><span id="VALeq"><span class="keyword">val</span> eq</span> : <code class="type">('a, 'c) <a href="Belt_Result.html#TYPEt">t</a> -><br> ('b, 'd) <a href="Belt_Result.html#TYPEt">t</a> -> ('a -> 'b -> bool) -> bool</code></pre><div class="info ">
<div class="not-examples">
<code class="code">eq res1 res2 f</code>
<p>
Determine if two <code class="code">Belt.Result</code> variables are equal with respect to an equality function.
If <code class="code">res1</code> and <code class="code">res2</code> are of the form <code class="code">Ok n</code> and <code class="code">Ok m</code>, return the result of <code class="code">f n m</code>.
If one of <code class="code">res1</code> and <code class="code">res2</code> are of the form <code class="code">Error e</code>, return false
If both <code class="code">res1</code> and <code class="code">res2</code> are of the form <code class="code">Error e</code>, return true<br>
</div>
<div class="examples">
<pre class="example"> <pre class="codepre"><code class="code"> let good1 = Ok 42
let good2 = Ok 32
let bad1 = Error "invalid"
let bad2 = Error "really invalid"
let mod10equal a b =
a mod 10 == b mod 10
eq good1 good2 mod10equal = true
eq good1 bad1 mod10equal = false
eq bad2 good2 mod10equal = false
eq bad1 bad2 mod10equal = true
</code></pre> </pre>
</div>
</div>
<pre><span id="VALcmpU"><span class="keyword">val</span> cmpU</span> : <code class="type">('a, 'c) <a href="Belt_Result.html#TYPEt">t</a> -><br> ('b, 'd) <a href="Belt_Result.html#TYPEt">t</a> -> ('a -> 'b -> int [@bs]) -> int</code></pre>
<pre><span id="VALcmp"><span class="keyword">val</span> cmp</span> : <code class="type">('a, 'c) <a href="Belt_Result.html#TYPEt">t</a> -> ('b, 'd) <a href="Belt_Result.html#TYPEt">t</a> -> ('a -> 'b -> int) -> int</code></pre><div class="info ">
<div class="not-examples">
<code class="code">cmp res1 res2 f</code>
<p>
Compare two <code class="code">Belt.Result</code> variables with respect to a comparison function.
The comparison function returns -1 if the first variable is "less than" the second,
0 if the two variables are equal, and 1 if the first is "greater than" the second.
<p>
If <code class="code">res1</code> and <code class="code">res2</code> are of the form <code class="code">Ok n</code> and <code class="code">Ok m</code>, return the result of <code class="code">f n m</code>.
If <code class="code">res1</code> is of the form <code class="code">Error e</code> and <code class="code">res2</code> of the form <code class="code">Ok n</code>, return -1 (nothing is less than something)
If <code class="code">res1</code> is of the form <code class="code">Ok n</code> and <code class="code">res2</code> of the form <code class="code">Error e</code>, return 1 (something is greater than nothing)
If both <code class="code">res1</code> and <code class="code">res2</code> are of the form <code class="code">Error e</code>, return 0 (equal)<br>
</div>
<div class="examples">
<pre class="example"> <pre class="codepre"><code class="code"> let good1 = Ok 59
let good2 = Ok 37
let bad1 = Error "invalid"
let bad2 = Error "really invalid"
let mod10cmp a b =
Pervasives.compare (a mod 10) (b mod 10)
cmp (Ok 39) (Ok 57) mod10cmp = 1
cmp (Ok 57) (Ok 39) mod10cmp = -1
cmp (Ok 39) (Error "y") mod10cmp = 1
cmp (Error "x") (Ok 57) mod10cmp = -1
cmp (Error "x") (Error "y") mod10cmp = 0
</code></pre> </pre>
</div>
</div>
</body></html>