package async_kernel

  1. Overview
  2. Docs
package async_kernel
Legend:
Library
Module
Module type
Parameter
Class
Class type
type 'a t = 'a Core.Or_error.t t
include Core.Monad.S with type 'a t := 'a t
val (>>=) : '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.

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

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

module Monad_infix : sig ... end
val bind : 'a t -> f:('a -> 'b t) -> 'b t

bind t ~f = t >>= f

val return : 'a -> 'a t

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

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

map t ~f is t >>| f.

val join : 'a t t -> 'a t

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

val 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 Caml.ignore. Some monads still do let ignore = ignore_m for historical reasons.

val all : 'a t list -> 'a list t
val 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.

module Let_syntax : sig ... end

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

val fail : Core.Error.t -> _ t
val ok_unit : unit t
val ok_exn : 'a t -> 'a t
val of_exn : exn -> _ t
val of_exn_result : ('a, exn) Core.Result.t t -> 'a t
val error : string -> 'a -> ('a -> Core.Sexp.t) -> _ t
val error_s : Core.Sexp.t -> _ t
val error_string : string -> _ t
val errorf : ('a, unit, string, _ t) Core.format4 -> 'a
val tag : 'a t -> tag:string -> 'a t
val tag_s : 'a t -> tag:Core.Sexp.t -> 'a t
val tag_s_lazy : 'a t -> tag:Core.Sexp.t Core.Lazy.t -> 'a t
val tag_arg : 'a t -> string -> 'b -> ('b -> Core.Sexp.t) -> 'a t
val unimplemented : string -> _ t
val find_map_ok : 'a list -> f:('a -> 'b t) -> 'b t
val try_with : ?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 f is eager only in the Ok case.

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.

val combine_errors : 'a t list -> 'a list t
val combine_errors_unit : unit t list -> unit t
val filter_ok_at_least_one : 'a t list -> 'a list t
module List : Async_kernel.Monad_sequence.S with type 'a monad := 'a t with type 'a t := 'a list
val repeat_until_finished : 'state -> ('state -> [ `Repeat of 'state | `Finished of 'result ] t) -> 'result t