Module Biocaml_unix.Biocaml_resultSource

Extension of Core's Result. Internal use only.

include module type of Core.Result
type ('a, 'b) t = ('a, 'b) Base.Result.t =
  1. | Ok of 'a
  2. | Error of 'b
include Bin_prot.Binable.S2 with type ('a, 'b) t := ('a, 'b) t
Sourceval bin_size_t : ('a, 'b, ('a, 'b) t) Bin_prot.Size.sizer2
Sourceval bin_write_t : ('a, 'b, ('a, 'b) t) Bin_prot.Write.writer2
Sourceval bin_read_t : ('a, 'b, ('a, 'b) t) Bin_prot.Read.reader2
Sourceval __bin_read_t__ : ('a, 'b, int -> ('a, 'b) t) Bin_prot.Read.reader2
Sourceval bin_writer_t : ('a, 'b, ('a, 'b) t) Bin_prot.Type_class.S2.writer
Sourceval bin_reader_t : ('a, 'b, ('a, 'b) t) Bin_prot.Type_class.S2.reader
Sourceval bin_t : ('a, 'b, ('a, 'b) t) Bin_prot.Type_class.S2.t
include Ppx_compare_lib.Comparable.S2 with type ('a, 'b) t := ('a, 'b) t
include Ppx_compare_lib.Equal.S2 with type ('a, 'b) t := ('a, 'b) t
include Ppx_hash_lib.Hashable.S2 with type ('a, 'b) t := ('a, 'b) t
include Sexplib0.Sexpable.S2 with type ('a, 'b) t := ('a, 'b) t
include Sexplib0.Sexpable.S2 with type ('ok, 'err) t := ('ok, 'err) t
val t_of_sexp : (Sexplib0.Sexp.t -> 'a) -> (Sexplib0.Sexp.t -> 'b) -> Sexplib0.Sexp.t -> ('a, 'b) t
val sexp_of_t : ('a -> Sexplib0.Sexp.t) -> ('b -> Sexplib0.Sexp.t) -> ('a, 'b) t -> Sexplib0.Sexp.t
val t_sexp_grammar : 'ok Sexplib0.Sexp_grammar.t -> 'err Sexplib0.Sexp_grammar.t -> ('ok, 'err) t Sexplib0.Sexp_grammar.t
val compare : 'a Base__.Ppx_compare_lib.compare -> 'b Base__.Ppx_compare_lib.compare -> ('a, 'b) t Base__.Ppx_compare_lib.compare
val equal : 'a Base__.Ppx_compare_lib.equal -> 'b Base__.Ppx_compare_lib.equal -> ('a, 'b) t Base__.Ppx_compare_lib.equal
val hash_fold_t : 'a Base__.Ppx_hash_lib.hash_fold -> 'b Base__.Ppx_hash_lib.hash_fold -> ('a, 'b) t Base__.Ppx_hash_lib.hash_fold
val (>>=) : ('a, 'e) t -> ('a -> ('b, 'e) t) -> ('b, 'e) t
val (>>|) : ('a, 'e) t -> ('a -> 'b) -> ('b, 'e) t
module Let_syntax = Core.Result.Let_syntax
module Monad_infix = Core.Result.Monad_infix
val bind : ('a, 'e) t -> f:('a -> ('b, 'e) t) -> ('b, 'e) t
val return : 'a -> ('a, _) t
val join : (('a, 'e) t, 'e) t -> ('a, 'e) t
val ignore_m : (_, 'e) t -> (unit, 'e) t
val all : ('a, 'e) t list -> ('a list, 'e) t
val all_unit : (unit, 'e) t list -> (unit, 'e) t
module Error = Core.Result.Error
val invariant : 'a Base__.Invariant_intf.inv -> 'b Base__.Invariant_intf.inv -> ('a, 'b) t Base__.Invariant_intf.inv
val fail : 'err -> (_, 'err) t
val failf : ('a, unit, string, (_, string) t) format4 -> 'a

e.g., failf "Couldn't find bloogle %s" (Bloogle.to_string b).

val is_ok : (_, _) t -> bool
val is_error : (_, _) t -> bool
val ok : ('ok, _) t -> 'ok option
val ok_exn : ('ok, exn) t -> 'ok
val ok_or_failwith : ('ok, string) t -> 'ok
val error : (_, 'err) t -> 'err option
val of_option : 'ok option -> error:'err -> ('ok, 'err) t
val iter : ('ok, _) t -> f:('ok -> unit) -> unit
val iter_error : (_, 'err) t -> f:('err -> unit) -> unit
val map : ('ok, 'err) t -> f:('ok -> 'c) -> ('c, 'err) t
val map_error : ('ok, 'err) t -> f:('err -> 'c) -> ('ok, 'c) t
val combine : ('ok1, 'err) t -> ('ok2, 'err) t -> ok:('ok1 -> 'ok2 -> 'ok3) -> err:('err -> 'err -> 'err) -> ('ok3, 'err) t

Returns Ok if both are Ok and Error otherwise.

val combine_errors : ('ok, 'err) t list -> ('ok list, 'err list) t

combine_errors ts returns Ok if every element in ts is Ok, else it returns Error with all the errors in ts.

This is similar to all from Monad.S2, with the difference that all only returns the first error.

val combine_errors_unit : (unit, 'err) t list -> (unit, 'err list) t

combine_errors_unit returns Ok if every element in ts is Ok (), else it returns Error with all the errors in ts, like combine_errors.

val to_either : ('ok, 'err) t -> ('ok, 'err) Base__.Either0.t

to_either is useful with List.partition_map. For example:

  let ints, exns =
    List.partition_map ["1"; "two"; "three"; "4"] ~f:(fun string ->
      Result.to_either (Result.try_with (fun () -> Int.of_string string)))
val of_either : ('ok, 'err) Base__.Either0.t -> ('ok, 'err) t
val ok_fst : ('ok, 'err) t -> ('ok, 'err) Base__.Either0.t
  • deprecated [since 2020-01] Use [to_either] instead.
val ok_if_true : bool -> error:'err -> (unit, 'err) t

ok_if_true returns Ok () if bool is true, and Error error if it is false.

val try_with : (unit -> 'a) -> ('a, exn) t
module Export = Core.Result.Export
Sourcemodule Stable = Core.Result.Stable
Sourcemodule List : sig ... end