package b0

  1. Overview
  2. Docs
On This Page
  1. Future values
Software construction and deployment kit

Install 

dune-project
 Dependency

erratique.ch Readme Changelog ISC; BSD-2-Clause License Edit opam file Versions (2)

Authors

  1. T
    The b0 programmers

Maintainers

  1. Daniel Bünzli

Sources

b0-0.0.5.tbz
sha512=00a6868b4dfa34565d0141b335622a81a0e8d5b9e3c6dfad025dabfa3df2db2a1302b492953bbbce30c3a4406c324fcec25250a00b38f6d18a69e15605e3b07e

doc/b0.std/B0_std/Fut/index.html

Module B0_std.Fut

Future values.

A future is an undetermined value that becomes determined at an an arbitrary point in the future. The future acts as a placeholder for the value while it is undetermined.

Future values

type 'a t

The type for futures with values of type 'a.

val create : unit -> 'a t * ('a -> unit)

create () is (f, set) with f the future value and set the function to set it. The latter can be called only once, Invalid_argument is raised otherwise.

val await : 'a t -> ('a -> unit) -> unit

await f k waits for f to be determined and continues with k v with v the value of the future. If the future never determines k is not invoked. k must not raise.

val value : 'a t -> 'a option

value f is f's value, if any.

val sync : 'a t -> 'a

sync f waits for f to determine. Warning. This is relaxed busy waiting.

val return : 'a -> 'a t

return v is a future that determines v.

val map : ('a -> 'b) -> 'a t -> 'b t

map fn f is return (fn v) with v the value of f.

val bind : 'a t -> ('a -> 'b t) -> 'b t

bind f fn is the future fn v with v the value of f.

val pair : 'a t -> 'b t -> ('a * 'b) t

pair f0 f1 determines with the value of f0 and f1.

val of_list : 'a t list -> 'a list t

of_list fs determines with the values of all fs, in the same order.

module Syntax : sig ... end

Future syntax.