package ecaml

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

Module Ecaml.VarSource

Sourcemodule type Wrap = sig ... end
Sourcetype 'a t = {
  1. symbol : Symbol.t;
  2. type_ : 'a Ecaml_value.Value.Type.t;
}
Sourceval type_ : 'a t -> 'a Ecaml_value.Value.Type.t
Sourceval symbol : 'a t -> Symbol.t
Sourceval sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t
type 'a var := 'a t
Sourceval create : Symbol.t -> 'a Ecaml_value.Value.Type.t -> 'a t
Sourcemodule Wrap : Wrap with type 'a t := 'a t

Idiomatic usage of Wrap looks like:

Sourcemodule And_value : sig ... end
Sourcemodule And_value_option : sig ... end
Sourceval symbol_as_value : _ t -> Ecaml_value.Value.t
Sourceval default_value_exn : 'a t -> 'a

(describe-function 'default-value) (Info-goto-node "(elisp)Default Value")

Sourceval default_value_is_defined : _ t -> bool

(describe-function 'default-boundp) (Info-goto-node "(elisp)Default Value")

Sourceval set_default_value : 'a t -> 'a -> unit

(describe-function 'set-default) (Info-goto-node "(elisp)Default Value")

Sourceval make_buffer_local_always : _ t -> unit

(describe-function 'make-variable-buffer-local) (Info-goto-node "(elisp)Creating Buffer-Local")

Sourceval is_buffer_local_always : _ t -> bool

is_buffer_local_always t returns true if t automatically becomes buffer-local when set. Calling make_buffer_local_always t causes is_buffer_local_always t = true.

Sourceval is_buffer_local_if_set : _ t -> Ecaml_value__.Value0.t -> bool

(describe-function 'local-variable-if-set-p ) (Info-goto-node "(elisp)Creating Buffer-Local")

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