Index of values


(>>=) [Rresult.R.Infix]
(>>=) is Rresult.R.(>>=).
(>>=) [Rresult.R]
r >>= f is Rresult.R.bind r f.
(>>=) [Rresult]
(>>=) is Rresult.R.(>>=).
(>>|) [Rresult.R.Infix]
(>>|) is Rresult.R.(>>|).
(>>|) [Rresult.R]
r >>| f is Rresult.R.map r f.
(>>|) [Rresult]
(>>|) is Rresult.R.(>>|).

B
bind [Rresult.R]
bind r f is f v if r = Ok v and r if r = Error _.

C
compare [Rresult.R]
compare ~ok ~error r r' totally orders r and r' using ok and error.

D
dump [Rresult.R]
dump ~ok ~error formats an OCaml result value using ok or error according to case, no parentheses are added.

E
equal [Rresult.R]
equal ~ok ~error r r' tests r and r' for equality using ok and error.
error [Rresult.R]
error e is Error e.
error_exn_trap_to_msg [Rresult.R]
error_exn_trap_to_msg r converts exception trap errors in r to an error message.
error_msg [Rresult.R]
error_msg s is error (`Msg s).
error_msg_to_invalid_arg [Rresult.R]
err_msg_to_invalid_arg r is v if r = Ok v and
error_msgf [Rresult.R]
error_msgf fmt ... is an error message formatted according to fmt.
error_to_msg [Rresult.R]
error_to_msg pp_error r converts errors in r with pp_error to an error message.

G
get_error [Rresult.R]
get_error r is e if r = Error e and
get_ok [Rresult.R]
get r is v if r = Ok v and

I
ignore_error [Rresult.R]
ignore_error ~use r is v if r = Ok v and use e if r = Error e.
is_error [Rresult.R]
is_error r is true iff r = Error _.
is_ok [Rresult.R]
is_ok r is true iff r = Ok _.

J
join [Rresult.R]
join r is v if r = Ok v and r otherwise.

K
kignore_error [Rresult.R]
kignore_error ~use r is r if r = Ok v and use e if r = Error e.

M
map [Rresult.R]
map f r is bind (fun v -> ret (f v)) r.
msg [Rresult.R]
msg s is `Msg s.
msgf [Rresult.R]
msgf fmt ... formats a message according to fmt.

O
of_option [Rresult.R]
of_option ~none r is Ok v if r = Some v and none () otherwise.
of_presult [Rresult.R]
of_presult pr is pr as a result value.
ok [Rresult.R]
ok v is Ok v.
open_error_exn_trap [Rresult.R]
open_error_exn_trap r allows to combine a closed exception trap error variant with other variants.
open_error_msg [Rresult.R]
open_error_msg r allows to combine a closed error message variant with other variants.

P
pp [Rresult.R]
pp ok error ppf r prints r on ppf using ok and error according to r.
pp_exn_trap [Rresult.R]
pp_exn_trap ppf bt prints bt on ppf.
pp_msg [Rresult.R]
pp_msg ppf m prints m on ppf.

R
reword_error [Rresult.R]
reword_error reword r is: r if r = Ok v, Error (reword e) if r = Error e
reword_error_msg [Rresult.R]
reword_error_msg ~replace reword r is like Rresult.R.reword_error except if replace is false (default), the result of reword old_msg is concatened, on a new line to the old message.

T
to_option [Rresult.R]
to_option r is Some v if r = Ok v and None otherwise.
to_presult [Rresult.R]
to_presult r is r as a polymorphic variant result value.
trap_exn [Rresult.R]
trap_exn f v is f v and traps any exception that may occur as an exception trap error.