File: effect_js.mli

package info (click to toggle)
js-of-ocaml 6.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 37,932 kB
  • sloc: ml: 135,957; javascript: 58,364; ansic: 437; makefile: 422; sh: 12; perl: 4
file content (31 lines) | stat: -rw-r--r-- 1,540 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
(* Js_of_ocaml library
 * http://www.ocsigen.org/js_of_ocaml/
 * Copyright (C) 2024 Olivier Nicole
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, with linking exception;
 * either version 2.1 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *)

(** Javascript-specific effect functions. *)

external assume_no_perform : (unit -> 'a) -> 'a = "caml_assume_no_perform"
(** Passing a function [f] as argument of `assume_no_perform` guarantees that,
    when compiling with `--effects=double-translation`, the direct-style
    version of [f] is called, which is faster than the CPS version. As a
    consequence, performing an effect in a transitive callee of [f] will raise
    `Effect.Unhandled`, regardless of any effect handlers installed before the
    call to `assume_no_perform`, unless a new effect handler was installed in
    the meantime.

    This behaviour is the same when double translation is disabled. *)