package ecaml

  1. Overview
  2. Docs
package ecaml
Legend:
Library
Module
Module type
Parameter
Class
Class type

Lower-level interface for functions that call from Emacs to OCaml.

Try Defun first.

module Fn : sig ... end
include Value.Subtype
type t = private Value.t

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.

val sexp_of_t : t -> Ppx_sexp_conv_lib.Sexp.t
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 is_in_subtype : Value.t -> bool
val of_value_exn : Ecaml_value__.Value0.t -> t
val type_ : t Value.Type.t
val create : Core_kernel.Source_code_position.t -> ?docstring:string -> ?interactive:string -> args:Symbol.t list -> ?optional_args:Symbol.t list -> ?rest_arg:Symbol.t -> Fn.t -> t
val create_nullary : Core_kernel.Source_code_position.t -> ?docstring:string -> ?interactive:string -> (unit -> unit) -> t
val to_value : t -> Value.t
val of_symbol : Symbol.t -> t
module Expert : sig ... end