package core_extended

  1. Overview
  2. Docs
package core_extended
Legend:
Library
Module
Module type
Parameter
Class
Class type
include module type of struct include Core.Result end
type ('a, 'b) t = ('a, 'b) Base.Result.t =
  1. | Ok of 'a
  2. | Error of 'b
include sig ... end
val bin_read_t : 'a Bin_prot.Read.reader -> 'b Bin_prot.Read.reader -> ('a, 'b) t Bin_prot.Read.reader
val __bin_read_t__ : 'a Bin_prot.Read.reader -> 'b Bin_prot.Read.reader -> (Base.Int.t -> ('a, 'b) t) Bin_prot.Read.reader
val bin_size_t : 'a Bin_prot.Size.sizer -> 'b Bin_prot.Size.sizer -> ('a, 'b) t Bin_prot.Size.sizer
include module type of Base.Result with type ('a, 'b) t := ('a, 'b) t
include sig ... end
val hash_fold_t : (Base.Hash.state -> 'ok -> Base.Hash.state) -> (Base.Hash.state -> 'err -> Base.Hash.state) -> Base.Hash.state -> ('ok, 'err) t -> Base.Hash.state
val compare : ('ok -> 'ok -> int) -> ('err -> 'err -> int) -> ('ok, 'err) t -> ('ok, 'err) t -> int
val t_of_sexp : (Base.Sexp.t -> 'ok) -> (Base.Sexp.t -> 'err) -> Base.Sexp.t -> ('ok, 'err) t
val sexp_of_t : ('ok -> Base.Sexp.t) -> ('err -> Base.Sexp.t) -> ('ok, 'err) t -> Base.Sexp.t
include Base.Monad.S2 with type ('a, 'err) t := ('a, 'err) t
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_ignore : (unit, 'e) t list -> (unit, 'e) t
val ignore : (_, 'err) t -> (unit, 'err) t
val fail : 'err -> (_, 'err) t
val failf : ('a, unit, string, (_, string) t) Pervasives.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 ok_fst : ('ok, 'err) t -> [ `Fst of 'ok | `Snd of 'err ]

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:'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
val ok_unit : (unit, _) t

ok_unit = Ok (), used to avoid allocation as a performance hack

module Export = Core.Result.Export
module Stable = Core.Result.Stable
include module type of struct include Extended_result end

Extension to the

ore.Result

module Ok = Extended_result.Ok
module Error = Extended_result.Error
module Exn = Extended_result.Exn
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct