simon/ocaml-containers
1
0
Fork 0
mirror of https://github.com/c-cube/ocaml-containers.git synced 2025-12-06 11:15:31 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

CCResult: add <$> operator

Browse source
This commit is contained in:
Kye W. Shi 2020-06-25 14:50:38 -07:00 • committed by Simon Cruanes
parent 0a3b04855a
commit 3bae829558
2 changed files with 7 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
src/core/CCResult.ml
View file

@ -282,6 +282,7 @@ let retry n f =
(** {2 Infix} *) (** {2 Infix} *)
module Infix = struct module Infix = struct
let (<$>) = map
let (>|=) e f = map f e let (>|=) e f = map f e
let (>>=) e f = flat_map f e let (>>=) e f = flat_map f e
let (<*>) = (<*>) let (<*>) = (<*>)

17
src/core/CCResult.mli
View file

@ -114,12 +114,6 @@ val catch : ('a, 'err) t -> ok:('a -> 'b) -> err:('err -> 'b) -> 'b
val flat_map : ('a -> ('b, 'err) t) -> ('a, 'err) t -> ('b, 'err) t val flat_map : ('a -> ('b, 'err) t) -> ('a, 'err) t -> ('b, 'err) t
val (>|=) : ('a, 'err) t -> ('a -> 'b) -> ('b, 'err) t
val (>>=) : ('a, 'err) t -> ('a -> ('b, 'err) t) -> ('b, 'err) t
(** Monadic composition. [e >>= f] proceeds as [f x] if [e] is [Ok x]
or returns [e] if [e] is an [Error]. *)
val equal : err:'err equal -> 'a equal -> ('a, 'err) t equal val equal : err:'err equal -> 'a equal -> ('a, 'err) t equal
val compare : err:'err ord -> 'a ord -> ('a, 'err) t ord val compare : err:'err ord -> 'a ord -> ('a, 'err) t ord
@ -168,11 +162,6 @@ val wrap3 : ('a -> 'b -> 'c -> 'd) -> 'a -> 'b -> 'c -> ('d, exn) t
val pure : 'a -> ('a, 'err) t val pure : 'a -> ('a, 'err) t
(** Synonym of {!return}. *) (** Synonym of {!return}. *)
val (<*>) : ('a -> 'b, 'err) t -> ('a, 'err) t -> ('b, 'err) t
(** [a <*> b] evaluates [a] and [b], and, in case of success, returns
[Ok (a b)]. Otherwise, it fails, and the error of [a] is chosen
over the error of [b] if both fail. *)
val join : (('a, 'err) t, 'err) t -> ('a, 'err) t val join : (('a, 'err) t, 'err) t -> ('a, 'err) t
(** [join t], in case of success, returns [Ok o] from [Ok (Ok o)]. Otherwise, (** [join t], in case of success, returns [Ok o] from [Ok (Ok o)]. Otherwise,
it fails with [Error e] where [e] is the unwrapped error of [t]. *) it fails with [Error e] where [e] is the unwrapped error of [t]. *)
@ -185,7 +174,11 @@ val both : ('a, 'err) t -> ('b, 'err) t -> (('a * 'b), 'err) t
(** {2 Infix} *) (** {2 Infix} *)
module Infix : sig module Infix : sig
val (<$>) : ('a -> 'b) -> ('a, 'err) t -> ('b, 'err) t
(** Infix version of [map]. *)
val (>|=) : ('a, 'err) t -> ('a -> 'b) -> ('b, 'err) t val (>|=) : ('a, 'err) t -> ('a -> 'b) -> ('b, 'err) t
(** Infix version of [map] with reversed arguments. *)
val (>>=) : ('a, 'err) t -> ('a -> ('b, 'err) t) -> ('b, 'err) t val (>>=) : ('a, 'err) t -> ('a -> ('b, 'err) t) -> ('b, 'err) t
(** Monadic composition. [e >>= f] proceeds as [f x] if [e] is [Ok x] (** Monadic composition. [e >>= f] proceeds as [f x] if [e] is [Ok x]
@ -201,6 +194,8 @@ module Infix : sig
include CCShimsMkLet_.S2 with type ('a,'e) t_let2 := ('a,'e) result include CCShimsMkLet_.S2 with type ('a,'e) t_let2 := ('a,'e) result
end end
include module type of Infix
(** Let operators on OCaml >= 4.08.0, nothing otherwise (** Let operators on OCaml >= 4.08.0, nothing otherwise
@since 2.8 *) @since 2.8 *)
include CCShimsMkLet_.S2 with type ('a,'e) t_let2 := ('a,'e) result include CCShimsMkLet_.S2 with type ('a,'e) t_let2 := ('a,'e) result