package ecaml

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

A character code is an integer representing a character. Emacs character codes are a superset of the Unicode standard.

(Info-goto-node "(elisp)Character Type") (Info-goto-node "(elisp)Character Codes")

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 -> Sexplib0.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
include Core.Equal.S with type t := t
val equal : t Base.Equal.equal
val of_int_exn : int -> t
val to_int : t -> int
val of_char_exn : char -> t

of_char_exn char raises if char isn't ASCII, i.e. if Char.to_int char >= 128.

val min_value : t

zero

val max_value : t

(describe-function 'max-char) (Info-goto-node "(elisp)Character Codes")