package ecaml

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

You can set up a timer to call a function at a specified future time or after a certain length of idleness.

Emacs cannot run timers at any arbitrary point in a program; it can run them only when Emacs could accept output from a subprocess: namely, while waiting or inside certain primitive functions such as sit-for or read-event which _can_ wait. Therefore, a timer's execution may be delayed if Emacs is busy. However, the time of execution is very precise if Emacs is idle.

(Info-goto-node "(elisp)Timers")

include Ecaml_value.Value.Subtype
type t = private Ecaml_value.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 : Ecaml_value.Value.t -> bool
val of_value_exn : Ecaml_value__.Value0.t -> t
val to_value : t -> Ecaml_value__.Value0.t
val type_ : t Ecaml_value.Value.Type.t
val all_scheduled : unit -> t list

(describe-variable 'timer-list)

val is_scheduled : t -> bool
val run_after : ?repeat:Core_kernel.Time_ns.Span.t -> Core_kernel.Source_code_position.t -> Core_kernel.Time_ns.Span.t -> f:(unit -> unit) -> name:Symbol.t -> t

(describe-function 'run-at-time) (Info-goto-node "(elisp)Timers")

val run_after_i : ?repeat:Core_kernel.Time_ns.Span.t -> Core_kernel.Source_code_position.t -> Core_kernel.Time_ns.Span.t -> f:(unit -> unit) -> name:Symbol.t -> unit

run_after_i s f = ignore (run_after s f)

val cancel : t -> unit

(describe-function 'cancel-timer) (Info-goto-node "(elisp)Timers")

val sit_for : ?redisplay:bool -> Core_kernel.Time_ns.Span.t -> unit

(describe-function 'sit-for) (Info-goto-node "(elisp)Waiting")

val sleep_for : Core_kernel.Time_ns.Span.t -> unit

(describe-function 'sleep-for) (Info-goto-node "(elisp)Waiting")