package async_kernel

  1. Overview
  2. Docs
package async_kernel
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Use.DeferredSource

Sourcetype nonrec 'a t = 'a Async_kernel.Deferred.t
include Async_kernel.Invariant.S1 with type 'a t := 'a t
Sourceval invariant : ('a -> unit) -> 'a t -> unit
include Core_kernel.Monad 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 Caml.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:

Sourcemodule Infix : sig ... end
Sourceval any : 'a t list -> 'a t
Sourceval any_unit : unit t list -> unit t
Sourceval both : 'a t -> 'b t -> ('a * 'b) t
Sourceval create : ('a Async_kernel.Ivar.t -> unit) -> 'a t
Sourceval don't_wait_for : unit t -> unit
Sourceval is_determined : 'a t -> bool
Sourceval never : unit -> _ t
Sourceval ok : 'a t -> ('a, _) Core_kernel.Result.t t
Sourceval peek : 'a t -> 'a option
Sourceval unit : unit t
Sourceval upon : 'a t -> ('a -> unit) -> unit
Sourceval value_exn : 'a t -> 'a
Sourceval repeat_until_finished : 'state -> ('state -> [ `Repeat of 'state | `Finished of 'result ] t) -> 'result t
Sourcemodule List : Async_kernel.Monad_sequence.S with type 'a monad := 'a t with type 'a t := 'a list
Sourcemodule Or_error : sig ... end
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