package ecaml

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

Module Ecaml_value.FunctionSource

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

Try Defun first.

Sourcemodule Fn : sig ... end
include Value.Subtype
Sourcetype 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.

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval 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.

Sourceval is_in_subtype : Value.t -> bool
Sourceval of_value_exn : Ecaml_value__.Value0.t -> t
Sourceval type_ : t Value.Type.t
Sourceval create : Core.Source_code_position.t -> ?docstring:string -> ?interactive:Value.t -> args:Symbol.t list -> ?optional_args:Symbol.t list -> ?rest_arg:Symbol.t -> Fn.t -> t
Sourceval create_nullary : Core.Source_code_position.t -> ?docstring:string -> ?interactive:Value.t -> (unit -> unit) -> t
Sourceval to_value : t -> Value.t
Sourceval of_symbol : Symbol.t -> t
Sourcemodule Expert : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct