package picos

You can search for identifiers within the package.

in-package search v0.2.0

package picos

picos
- Picos
  - Computation
  - Fiber
    
    FLS
    
    Maybe
  - Handler
  - Trigger
picos.domain
- Picos_domain
  - DLS
picos.exn_bt
- Picos_exn_bt
picos.fd
- Picos_fd
  - Resource
picos.fifos
- Picos_fifos
picos.htbl
- Picos_htbl
picos.mpsc_queue
- Picos_mpsc_queue
picos.rc
- Picos_rc
  - Make
    
    Resource
  - Resource
  - S
    
    Resource
picos.select
- Picos_select
  - Intr
picos.stdio
- Picos_stdio
  - Unix
    
    LargeFile
picos.sync
- Picos_sync
  - Condition
  - Lazy
  - Mutex
picos.thread
- Picos_thread
  - TLS
picos.threaded
- Picos_threaded

Legend:
Library
Module
Module type
Parameter
Class
Class type

Handler for the effects based operations of Picos for OCaml 4.

type 'c t = {

current : 'c -> Fiber.t;
(*
See Picos.Fiber.current.
*)
spawn : 'a. 'c -> forbid:bool -> 'a Computation.t -> (unit -> unit) list -> unit;
(*
See Picos.Fiber.spawn.
*)
yield : 'c -> unit;
(*
See Picos.Fiber.yield.
*)
cancel_after : 'a. 'c -> 'a Computation.t -> seconds:float -> Exn_bt.t -> unit;
(*
See Picos.Computation.cancel_after.
*)
await : 'c -> Trigger.t -> Exn_bt.t option;
(*
See Picos.Trigger.await.
*)

}

A record of implementations of the primitive effects based operations of Picos. The operations take a context of type 'c as an argument.

val using : 'c t -> 'c -> (unit -> 'a) -> 'a

using handler context thunk sets the handler and the context for the handler of the primitive effects based operations of Picos while running thunk.

ℹ️ The behavior is that

on OCaml 4, using stores the handler in TLS, which allows the operations to be accessed during the execution of the thunk, and
on OCaml 5, using runs thunk with a deep effect handler that delegates to the operations of the handler.

⚠️ While this works on OCaml 5, you usually want to use a scheduler that implements an effect handler directly, because that is likely to perform better.