package ecaml

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

Module Buffer_local.WrapSource

Idiomatic usage of Wrap looks like:

 Buffer_local.Wrap.(SYMBOL_NAME <: TYPE) 

For example:

 Buffer_local.Wrap.("default-directory" <: string) 

To use ~make_buffer_local_always:true, the idiom is:

  Buffer_local.Wrap.(
    let ( <: ) = ( <: ) ~make_buffer_local_always:true in
    SYMBOL_NAME <: TYPE)
Sourceval (<:) : ?make_buffer_local_always:bool -> string -> 'a Ecaml_value.Value.Type.t -> 'a t
include Ecaml_value.Value.Type.S
Sourceval string : string Ecaml_value.Value.Type.t
Sourceval string_cached : string Ecaml_value.Value.Type.t

string_cached is like string, except it uses of_utf8_bytes_cached.

Sourceval array_as_list : 'a Ecaml_value.Value.Type.t -> 'a array Ecaml_value.Value.Type.t

Represent an ocaml array as an elisp list, without creating an intermediate ocaml list.

option represents None as nil and Some a as cons v nil, where v is the representation of a.

nil_or t represents None as nil and Some a as v, where v is the representation of a. This is a common representation used by Elisp functions. But it is only correct if nil is not a representation of any value in t; in that situation use Type.option.

Represent a tuple (a,b) as the elisp cons cell (a . b)

Represent a tuple (a,b) as the elisp list '(a b)

Sourceval sexpable : (module Core.Sexpable with type t = 'a) -> name:Core.Sexp.t -> 'a Ecaml_value.Value.Type.t

Embed a sexpable ocaml type, so we can save values of the type in emacs, e.g. as buffer local variables

Sourceval path_list : string list Ecaml_value.Value.Type.t

A list of directories. Each element is a string (directory name) or nil (try default directory). nil values are converted to ".", which has the same meaning.

OCaml

Innovation. Community. Security.