package lsp

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Generals
Joining
Forking + joining
Local storage
Error handling
Synchronization
Running fibers

package lsp

lsp
- Lsp
lsp.fiber
- Fiber
  - Ivar
  - Mutex
  - Mvar
  - O
  - Sequence
  - Throttle
  - Var
lsp.fiber_unix
- Fiber_unix
  - Fiber_detached
  - Fiber_stream
    
    In
    
    Out
  - Private
    
    Removable_queue
  - Scheduler
lsp.stdune
- Stdune
  - Ansi_color
    
    Style
  - Appendable_list
  - Applicative
    
    Id
    
    O
    
    Make
    
    A
    
    O
  - Applicative_intf
    
    S1
    
    O
    
    S1_base
  - Array
  - Bin
  - Bool
  - Bytes
  - Char
  - Code_error
  - Comparable
    
    Make
    
    Key
    
    Map
    
    Multi
    
    Set
  - Comparable_intf
    
    S
    
    Key
    
    Map
    
    Multi
    
    Set
  - Comparator
    
    OPS
    
    Operators
    
    X
    
    S
  - Console
    
    Backend
    
    S
    
    Status_line
  - Csexp
    
    Input
    
    Monad
    
    Make_parser
    
    Input
    
    Monad
    
    Parser
    
    Lexer
    
    Stack
  - Daemonize
  - Digest
    
    Set
  - Dyn
    
    Encoder
  - Either
  - Env
    
    Map
    
    Multi
    
    Var
    
    Set
  - Exn
  - Exn_with_backtrace
  - Fcntl
  - Fdecl
  - Filename
  - Float
  - Fun
  - Hashtbl
    
    Make
    
    Key
    
    S
  - Id
    
    Make
    
    Map
    
    Multi
    
    Set
    
    S
    
    Map
    
    Multi
    
    Set
  - Int
    
    Infix
    
    Map
    
    Multi
    
    Set
  - Interned
    
    Make
    
    Map
    
    Multi
    
    R
    
    Set
    
    Table
    
    No_interning
    
    Map
    
    Multi
    
    R
    
    Set
    
    Table
    
    Settings
  - Interned_intf
    
    S
    
    Map
    
    Multi
    
    Set
    
    Table
  - Io
    
    String_path
  - Lexbuf
  - List
  - Loc
    
    Map
    
    Multi
  - Lock_file
  - Map
    
    Key
    
    Make
    
    Key
    
    Multi
    
    S
    
    Multi
  - Monad
    
    Id
    
    O
    
    Make
    
    M
    
    O
  - Monad_intf
    
    S1
    
    O
    
    S1_base
  - Nothing
  - Option
    
    List
    
    O
  - Or_exn
    
    O
  - Ordering
  - Path
    
    Build
    
    Kind
    
    L
    
    Map
    
    Multi
    
    Set
    
    Table
    
    External
    
    Map
    
    Multi
    
    Set
    
    Table
    
    L
    
    Local
    
    L
    
    Map
    
    Multi
    
    Set
    
    Table
    
    Local_gen
    
    Fix_root
    
    Map
    
    Multi
    
    Root
    
    Set
    
    Table
    
    L
    
    Map
    
    Multi
    
    Set
    
    Source
    
    L
    
    Map
    
    Multi
    
    Set
    
    Table
    
    Table
    
    Unspecified
  - Pid
  - Poly
  - Pp
    
    O
  - Proc
  - Queue
  - Result
    
    List
    
    O
    
    Option
  - Scanf
  - Set
    
    Make
    
    Key
    
    M
    
    Multi
    
    S
  - Sexp
  - Signal
  - Spawn
    
    Env
  - Staged
  - String
    
    Map
    
    Multi
    
    Set
    
    Table
  - Sys
  - Table
    
    Key
  - Top_closure
    
    Int
    
    Make
    
    Keys
    
    Monad
    
    O
    
    String
  - Top_closure_intf
    
    Keys
    
    S
  - Tuple
    
    T2
    
    T3
  - Type_eq
    
    Id
  - Unit
  - Univ_map
    
    Key
  - User_error
  - User_message
    
    Print_config
    
    Style
  - User_warning

Legend:
Library
Module
Module type
Parameter
Class
Class type

Concurrency library

This module implements "structured concurrency".

Generals

type 'a t

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.

val return : 'a -> 'a t

Create a fiber that has already terminated.

val of_thunk : (unit -> 'a t) -> 'a 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.

val never : 'a t

Fiber that never completes.

module O : sig ... end

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

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

Joining

The following combinators are helpers to combine the result of several fibers into one. Note that they do not introduce parallelism.

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

val sequential_map : 'a list -> f:('a -> 'b t) -> 'b list t

val sequential_iter : 'a list -> f:('a -> unit t) -> unit t

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.

val fork_and_join : (unit -> 'a t) -> (unit -> 'b t) -> ('a * 'b) t

Start two fibers and wait for their results.

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

Same but assume the first fiber returns unit.

val parallel_map : 'a list -> f:('a -> 'b t) -> 'b list t

Map a list in parallel.

val parallel_iter : 'a list -> f:('a -> unit t) -> unit t

Iter over a list in parallel.

Local storage

module Var : sig ... end

Variables local to a fiber

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)

val finalize : (unit -> 'a t) -> finally:(unit -> unit t) -> 'a t

finalize f ~finally runs finally after f () has terminated, whether it fails or succeeds.

Synchronization

module Ivar : sig ... end

Write once variables

module Mvar : sig ... end

Mailbox variables

module Mutex : sig ... end

module Throttle : sig ... end

Limit the number of jobs

module Sequence : sig ... end

Running fibers

type fill =

| Fill : 'a Ivar.t * 'a -> fill

val run : 'a t -> iter:(unit -> fill) -> 'a

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.

val fork_and_race : 
  (unit -> 'a t) ->
  (unit -> 'b t) ->
  ('a, 'b) Stdune.Either.t t