diff --git a/README b/README index a4e6c5b029e79bc9f2d326b3087ddee5282c5989..481e3eedfdf4cd7b532e8c12e30e815b1a3b8b8d 100644 --- a/README +++ b/README @@ -55,6 +55,14 @@ function pcall (thunk &optional (future-type *default-future-type*)) => future The function is called in an unspecified dynamic environment. +special variable *default-future-type* + + One of :eager, :speculative (default) or :lazy. If eager, any newly + created futures start their computation immediately. If speculative, + newly created futures are computed when thread pool threads are + available, in FIFO future creation order. If lazy, newly created + futures are not computed until asked to yield their values. + function ready-to-yield? (future) => nil or non-nil Returns non-nil if the future values have been computed, nil otherwise.