Module Result


module Result: sig .. end
Result is often used to handle error messages.


type ('a, 'b) t =
| Ok of 'a
| Error of 'b
'a is a function's expected return type, and 'b is often an error message string.
let ric_of_ticker = function
      | "IBM" -> Ok "IBM.N"
      | "MSFT" -> Ok "MSFT.OQ"
      | "AA" -> Ok "AA.N"
      | "CSCO" -> Ok "CSCO.OQ"
      | _ as ticker -> Error (sprintf "can't find ric of %s" ticker) 
The return type of ric_of_ticker could be string option, but (string, string) Result.t gives more control over the error message.
include Sexpable.S2
include Binable.S2
include Monad.S2
val fail : 'a -> ('b, 'a) t
val failf : ('a, unit, string, ('b, string) t) Pervasives.format4 -> 'a
e.g. failf "Couldn't find bloogle %s" (Bloogle.to_string b)
val is_ok : ('a, 'b) t -> bool
val is_error : ('a, 'b) t -> bool
val ok : ('a, 'b) t -> 'a option
val error : ('a, 'b) t -> 'b option
val of_option : 'a option -> error:'b -> ('a, 'b) t
val iter : ('a, 'b) t -> f:('a -> unit) -> unit
val map : ('a, 'b) t -> f:('a -> 'c) -> ('c, 'b) t
val map_error : ('a, 'b) t -> f:('b -> 'c) -> ('a, 'c) t
val combine : ('a, 'b) t ->
('c, 'b) t ->
ok:('a -> 'c -> 'd) -> err:('b -> 'b -> 'b) -> ('d, 'b) t
val call : f:('a -> unit, 'b) t -> 'a -> unit
val apply : f:('a -> 'b, 'c) t -> 'a -> ('b, 'c) t
val ok_fst : ('a, 'b) t -> [ `Fst of 'a | `Snd of 'b ]
ok_fst is useful with List.partition_map. Continuing the above example:
    let rics, errors = List.partition_map ~f:Result.ok_fst
      (List.map ~f:ric_of_ticker ["AA"; "F"; "CSCO"; "AAPL"]) 

val ok_if_true : bool -> error:'a -> (unit, 'a) t
val try_with : (unit -> 'a) -> ('a, exn) t
val ok_exn : ?fail:exn -> ('a, 'b) t -> 'a
ok_exn t returns x if t = Ok x, otherwise it raises an exn.
val raise_error : ('a, exn) t -> 'a
raise_error t returns x if t = Ok x, and raises exn if t = Error exn
val ok_unit : (unit, 'a) t
ok_unit = Ok (), used to avoid allocation as a performance hack
module Export: sig .. end