package ecaml

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

A Vector.t is a general-purpose array whose elements are Value.t's.

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

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.

include sig ... end
val sexp_of_t : t -> Sexplib.Sexp.t
val of_value_exn : Value.t -> t
val to_value : t -> Value.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 type_ : 'a Value.Type.t -> 'a array Value.Type.t
val create : len:int -> Value.t -> t

(describe-function 'make-vector)

val length : t -> int
val get : t -> int -> Value.t
val set : t -> int -> Value.t -> unit
val of_list : Value.t list -> t

(describe-function 'vector)

val concat : t list -> t

(describe-function 'vconcat)

val to_array : t -> f:(Value.t -> 'a) -> 'a array