Module Topkg.R

Result value combinators.

Errors

val reword_error : ('b -> 'c) -> ('a, 'b) Result.result -> ('a, 'c) Result.result

reword_error reword r is:

  • r if r = Ok v
  • Error (reword e) if r = Error e

Error messages

type msg = [
| `Msg of string
]

The type for (error) messages.

val error_msg : string -> ('b, [> msg ]) Result.result

error_msg s is Error (`Msg s).

val error_msgf : ('a, Stdlib.Format.formatter, unit, ('b, [> msg ]) Result.result) Stdlib.format4 -> 'a

error_msgf fmt ... is an error formatted according to fmt.

val reword_error_msg : ?⁠replace:bool -> (string -> msg) -> ('a, msg) Result.result -> ('a, [> msg ]) Result.result

reword_error_msg ~replace reword r is like reword_error except if replace is false (default), the result of reword old_msg is concatened, on a new line to the old message.