package async_kernel

  1. Overview
  2. Docs
Monadic concurrency library

Install 

dune-project
 Dependency

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

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

v0.17.0.tar.gz
sha256=01ced973dbc70535f692f38bed524ae82dba17e26e58791b2fbf0d647b160d2e

doc/async_kernel.eager_deferred/Eager_deferred/index.html

Module Eager_deferredSource

Sourcemodule 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
Sourceval 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.

Sourceval (>>|) : 'a Async_kernel.Deferred.t -> ('a -> 'b) -> 'b Async_kernel.Deferred.t

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

Sourcemodule Monad_infix : sig ... end

bind t ~f = t >>= f

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

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

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

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 create : ('a Async_kernel.Ivar.t -> unit) -> 'a Async_kernel.Deferred.t
Sourceval don't_wait_for : unit Async_kernel.Deferred.t -> unit
Sourceval is_determined : 'a Async_kernel.Deferred.t -> bool
Sourceval never : unit -> _ Async_kernel.Deferred.t
Sourceval peek : 'a Async_kernel.Deferred.t -> 'a option
Sourceval upon : 'a Async_kernel.Deferred.t -> ('a -> unit) -> unit
Sourceval value_exn : 'a Async_kernel.Deferred.t -> 'a
Sourceval repeat_until_finished : 'state -> ('state -> [ `Repeat of 'state | `Finished of 'result ] Async_kernel.Deferred.t) -> 'result Async_kernel.Deferred.t
Sourcemodule List : Async_kernel.Monad_sequence.S with type 'a monad := 'a Async_kernel.Deferred.t with type 'a t := 'a list

Similar to Deferred.Queue but eager when passing ~how:`Sequential. The functions in Queue raise if the queue is mutated during execution.

Sourcemodule Or_error : sig ... end
Sourcemodule Result : sig ... end
Sourcemodule 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.