package async_kernel

You can search for identifiers within the package.

in-package search v0.2.0

Monadic concurrency library

Install

Dune Dependency

github.com Readme Changelog MIT License Edit opam file Versions (6)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

async_kernel-v0.13.0.tar.gz

sha256=55a32c8b8e6aaaecb8357644515884367ec99b703fe8f984212b714a0e554c65

md5=d12b61a3f95325a511c50964bc9c819e

doc/async_kernel.eager_deferred/Eager_deferred/index.html

Module `Eager_deferred`

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_kernel.Monad with type 'a t := 'a Async_kernel.Deferred.t

val (>>=) : 
  'a Async_kernel.Deferred.t ->
  ('a -> 'b Async_kernel.Deferred.t) ->
  'b 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

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

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.

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

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

val ignore_m : 'a Async_kernel.Deferred.t -> unit Async_kernel.Deferred.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 Async_kernel.Deferred.t list -> 'a list Async_kernel.Deferred.t

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 : 'a Async_kernel.Deferred.t list -> 'a Async_kernel.Deferred.t

val any_unit : 
  unit Async_kernel.Deferred.t list ->
  unit Async_kernel.Deferred.t

val both : 
  'a Async_kernel.Deferred.t ->
  'b Async_kernel.Deferred.t ->
  ('a * 'b) 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 ignore : _ Async_kernel.Deferred.t -> unit Async_kernel.Deferred.t

deprecated [since 2019-06] Use [ignore_m] instead.

val is_determined : 'a Async_kernel.Deferred.t -> bool

val never : unit -> _ Async_kernel.Deferred.t

val ok : 
  'a Async_kernel.Deferred.t ->
  ('a, _) Core_kernel.Result.t 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 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.