Module Ecaml.Function

Functions that call from Emacs to OCaml.

module Fn : sig ... end
include Value.Subtype
type value
type 'a type_
type t = private value

We expose private value for free identity conversions when the value is nested in some covariant type, e.g. (symbols : Symbol.t list :> Value.t list) rather than List.map symbols ~f:Symbol.to_value.

include sig ... end
val sexp_of_t : t ‑> Sexplib.Sexp.t
val of_value_exn : value ‑> t
val to_value : t ‑> value
val eq : t ‑> t ‑> bool

eq t1 t2 = Value.eq (to_value t1) (to_value t2), i.e. eq checks whether the Emacs values underlying t1 and t2 are physically equal. This is different than phys_equal t1 t2, because we don't always wrap eq Emacs values in phys_equal OCaml values. I.e. phys_equal t1 t2 implies eq t1 t2, but not the converse.

val type_ : t type_
type 'a with_spec = ?⁠docstring:string ‑> ?⁠interactive:string ‑> ?⁠optional_args:Symbol.t list ‑> ?⁠rest_arg:Symbol.t ‑> Core_kernel.Source_code_position.t ‑> args:Symbol.t list ‑> 'a
val create : (Fn.t ‑> t) with_spec
val defun : (Symbol.t ‑> Fn.t ‑> unit) with_spec
val to_value : t ‑> Value.t
module Expert : sig ... end