Module `Eager_deferred.Or_error`Source

Sourcetype 'a t = 'a Core.Or_error.t Async_kernel.Deferred.t

include Core.Monad.S with type 'a t := 'a t

Sourceval (>>=) : 'a t -> ('a -> 'b t) -> 'b t

t >>= f returns a computation that sequences the computations represented by two monad elements. The resulting computation first does t to yield a value v, and then runs the computation returned by f v.

Sourceval (>>|) : 'a t -> ('a -> 'b) -> 'b t

t >>| f is t >>= (fun a -> return (f a)).

Sourcemodule Monad_infix : sig ... end

Sourceval bind : 'a t -> f:('a -> 'b t) -> 'b t

bind t ~f = t >>= f

Sourceval return : 'a -> 'a t

return v returns the (trivial) computation that returns v.

Sourceval map : 'a t -> f:('a -> 'b) -> 'b t

map t ~f is t >>| f.

Sourceval join : 'a t t -> 'a t

join t is t >>= (fun t' -> t').

Sourceval ignore_m : 'a t -> unit t

ignore_m t is map t ~f:(fun _ -> ()). ignore_m used to be called ignore, but we decided that was a bad name, because it shadowed the widely used Stdlib.ignore. Some monads still do let ignore = ignore_m for historical reasons.

Sourceval all : 'a t list -> 'a list t

Sourceval all_unit : unit t list -> unit t

Like all, but ensures that every monadic value in the list produces a unit value, all of which are discarded rather than being collected into a list.

Sourcemodule Let_syntax : sig ... end

These are convenient to have in scope when programming with a monad:

Sourceval fail : Core.Error.t -> _ t

Sourceval ok_unit : unit t

Sourceval ok_exn : 'a t -> 'a Async_kernel.Deferred.t

Sourceval of_exn : ?backtrace:[ `Get | `This of string ] -> exn -> _ t

Source

val of_exn_result : 
  ?backtrace:[ `Get | `This of string ] ->
  ('a, exn) Core.Result.t Async_kernel.Deferred.t ->
  'a t

Sourceval error : string -> 'a -> ('a -> Core.Sexp.t) -> _ t

Sourceval error_s : Core.Sexp.t -> _ t

Sourceval error_string : string -> _ t

Sourceval errorf : ('a, unit, string, _ t) Core.format4 -> 'a

Sourceval tag : 'a t -> tag:string -> 'a t

Sourceval tag_s : 'a t -> tag:Core.Sexp.t -> 'a t

Sourceval tag_s_lazy : 'a t -> tag:Core.Sexp.t Core.Lazy.t -> 'a t

Sourceval tag_arg : 'a t -> string -> 'b -> ('b -> Core.Sexp.t) -> 'a t

Sourceval unimplemented : string -> _ t

Sourceval find_map_ok : 'a list -> f:('a -> 'b t) -> 'b t

Source

val try_with : 
  ?extract_exn:bool ->
  ?run:[ `Now | `Schedule ] ->
  ?rest:[ `Log | `Raise | `Call of exn -> unit ] ->
  ?here:Lexing.position ->
  ?name:string ->
  (unit -> 'a Async_kernel.Deferred.t) ->
  'a t

Note that try_with f is eager only in the Ok case.

Source

val try_with_join : 
  ?extract_exn:bool ->
  ?run:[ `Now | `Schedule ] ->
  ?rest:[ `Log | `Raise | `Call of exn -> unit ] ->
  ?here:Lexing.position ->
  ?name:string ->
  (unit -> 'a t) ->
  'a t

Note that try_with_join f is eager only when no exception is raised by f.

Sourceval combine_errors : 'a t list -> 'a list t

Sourceval combine_errors_unit : unit t list -> unit t

Sourceval filter_ok_at_least_one : 'a t list -> 'a list t

Source

module List : 
  Async_kernel.Monad_sequence.S
    with type 'a monad := 'a t
    with type 'a t := 'a list

Source

val repeat_until_finished : 
  'state ->
  ('state -> [ `Repeat of 'state | `Finished of 'result ] t) ->
  'result t

Install

Dune Dependency

Authors

Maintainers

Sources

doc/async_kernel.eager_deferred/Eager_deferred/Or_error/index.html

Module `Eager_deferred.Or_error`Source

package async_kernel

Install

Dune Dependency

Authors

Maintainers

Sources

doc/async_kernel.eager_deferred/Eager_deferred/Or_error/index.html

Module Eager_deferred.Or_errorSource

Module `Eager_deferred.Or_error`Source