package merlin-lib
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=67da3b34f2fea07678267309f61da4a2c6f08298de0dc59655b8d30fd8269af1
sha512=1fb3b5180d36aa82b82a319e15b743b802b6888f0dc67645baafdb4e18dfc23a7b90064ec9bc42f7424061cf8cde7f8839178d8a8537bf4596759f3ff4891873
doc/merlin-lib.utils/Merlin_utils/Std/Result/index.html
Module Std.Result
Source
include module type of struct include Result end
Results
The type for result values. Either a value Ok v
or an error Error e
.
value r ~default
is v
if r
is Ok v
and default
otherwise.
join rr
is r
if rr
is Ok r
and rr
if rr
is Error _
.
map_error f r
is Error (f e)
if r
is Error e
and r
if r
is Ok _
.
fold ~ok ~error r
is ok v
if r
is Ok v
and error e
if r
is Error e
.
iter f r
is f v
if r
is Ok v
and ()
otherwise.
iter_error f r
is f e
if r
is Error e
and ()
otherwise.
Predicates and comparisons
val equal :
ok:('a -> 'a -> bool) ->
error:('e -> 'e -> bool) ->
('a, 'e) result ->
('a, 'e) result ->
bool
equal ~ok ~error r0 r1
tests equality of r0
and r1
using ok
and error
to respectively compare values wrapped by Ok _
and Error _
.
val compare :
ok:('a -> 'a -> int) ->
error:('e -> 'e -> int) ->
('a, 'e) result ->
('a, 'e) result ->
int
compare ~ok ~error r0 r1
totally orders r0
and r1
using ok
and error
to respectively compare values wrapped by Ok _
and Error _
. Ok _
values are smaller than Error _
values.
Converting
to_option r
is r
as an option, mapping Ok v
to Some v
and Error _
to None
.