package lsp
Install
Dune Dependency
Authors
Maintainers
Sources
md5=2c19731536a4f62923554c1947c39211
sha512=9bc252e2564fe6c9017b5ee1b2c4ddebf73c4be4b2a3d48f1d61b6ec1910a2cb9f4fa4952a7a6d89482c28ddbad8e0d9c34c206a1b2fe42bb2c3a7156aa953e9
doc/lsp.fiber/Fiber/index.html
Module Fiber
Source
Concurrency library
This module implements "structured concurrency".
Generals
Type of fiber. A fiber represent a suspended computation. Note that using the same fiber twice will execute it twice, which is probably not what you want. To share the result of a fiber, use an Ivar.t
.
Converts a thunk to a fiber, making sure the thunk runs in the context of the fiber (rather than applied in the current context).
Equivalent to (>>=) (return ())
, but more explicit.
Joining
The following combinators are helpers to combine the result of several fibers into one. Note that they do not introduce parallelism.
Forking + joining
The following functions combine forking 2 or more fibers followed by joining the results. The execution of the various fibers might be interleaved, however once the combining fiber has terminated, it is guaranteed that there are no fibers lingering around.
Start two fibers and wait for their results.
Same but assume the first fiber returns unit
.
Local storage
Error handling
val with_error_handler :
(unit -> 'a t) ->
on_error:(Stdune.Exn_with_backtrace.t -> unit) ->
'a t
with_error_handler f ~on_error
calls on_error
for every exception raised during the execution of f
. This include exceptions raised when calling f ()
or during the execution of fibers after f ()
has returned. Exceptions raised by on_error
are passed on to the parent error handler.
It is guaranteed that after the fiber has returned a value, on_error
will never be called.
val fold_errors :
(unit -> 'a t) ->
init:'b ->
on_error:(Stdune.Exn_with_backtrace.t -> 'b -> 'b) ->
('a, 'b) Stdune.Result.t t
fold_errors f ~init ~on_error
calls on_error
for every exception raised during the execution of f
. This include exceptions raised when calling f ()
or during the execution of fibers after f ()
has returned.
Exceptions raised by on_error
are passed on to the parent error handler.
val collect_errors :
(unit -> 'a t) ->
('a, Stdune.Exn_with_backtrace.t list) Stdune.Result.t t
collect_errors f
is: fold_errors f ~init:[] ~on_error:(fun e l -> e :: l)
finalize f ~finally
runs finally
after f ()
has terminated, whether it fails or succeeds.
Synchronization
Running fibers
run t ~iter
runs a fiber until it terminates. iter
is used to implement the scheduler, it should block waiting for an event and return an ivar to fill.