package async_kernel

  1. Overview
  2. Docs
package async_kernel
Legend:
Library
Module
Module type
Parameter
Class
Class type
module type S = sig ... end
include S with type 'a t := 'a Async_kernel.Deferred.t
include Async_kernel.Invariant.S1 with type 'a t := 'a Async_kernel.Deferred.t
val invariant : ('a -> unit) -> 'a Async_kernel.Deferred.t -> unit
include Core.Monad with type 'a t := 'a Async_kernel.Deferred.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 Async_kernel.Deferred.t -> ('a -> 'b) -> 'b Async_kernel.Deferred.t

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

module Monad_infix : sig ... end

bind t ~f = t >>= f

val return : 'a -> 'a Async_kernel.Deferred.t

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

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

map t ~f is t >>| f.

join t is t >>= (fun t' -> 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_unit : unit Async_kernel.Deferred.t list -> unit Async_kernel.Deferred.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:

module Infix : sig ... end
val any_unit : unit Async_kernel.Deferred.t list -> unit Async_kernel.Deferred.t
val create : ('a Async_kernel.Ivar.t -> unit) -> 'a Async_kernel.Deferred.t
val don't_wait_for : unit Async_kernel.Deferred.t -> unit
val is_determined : 'a Async_kernel.Deferred.t -> bool
val never : unit -> _ Async_kernel.Deferred.t
val peek : 'a Async_kernel.Deferred.t -> 'a option
val unit : unit Async_kernel.Deferred.t
val upon : 'a Async_kernel.Deferred.t -> ('a -> unit) -> unit
val value_exn : 'a Async_kernel.Deferred.t -> 'a
val repeat_until_finished : 'state -> ('state -> [ `Repeat of 'state | `Finished of 'result ] Async_kernel.Deferred.t) -> 'result Async_kernel.Deferred.t
module List : Async_kernel.Monad_sequence.S with type 'a monad := 'a Async_kernel.Deferred.t with type 'a t := 'a list
module Or_error : sig ... end
module Result : sig ... end
module Use : sig ... end

Intended usage is to open Eager_deferred.Use to shadow operations from the non-eager world and rebind them to their eager counterparts.

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