package async_kernel

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

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_kernel.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 Caml.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
Sourcemodule Or_error : 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.

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