package ecaml

You can search for identifiers within the package.

in-package search v0.2.0

ecaml
- Ecaml
  - Abbrev
  - Advice
    
    On_parse_error
  - Ansi_color
    
    Colors
  - Async_ecaml
    
    Expect_test_config
    
    IO
    
    Expect_test_config_allowing_nested_block_on_async
    
    IO
    
    Export
    
    Clock
    
    Private
  - Auto_mode_alist
    
    Entry
  - Background
    
    Clock
    
    Private
  - Backup
  - Bookmark
    
    Make_record_function
    
    Return_type
    
    Property
    
    And_value
    
    Record
  - Browse_url
    
    Private
    
    Url
  - Buffer
    
    Blocking
    
    Compare_by_name
    
    Map
    
    Diff
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Set
    
    Diff
    
    Elt
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Which_buffers
  - Buffer_local
    
    Private
    
    Wrap
  - Char_code
  - Clipboard
  - Color
    
    Frame
    
    RGB
  - Command
    
    Private
    
    Raw_prefix_argument
  - Comment
    
    Terminated_by
  - Compilation
  - Completing
    
    Initial_input
    
    Require_match
  - Current_buffer
    
    Coding_system
  - Customization
    
    Enum_arg
    
    Group
    
    Private
    
    Type
    
    Wrap
  - Debugger
  - Defconst
    
    Private
  - Defun
    
    For_testing
    
    Interactive
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Obsoletes
    
    Since
    
    Open_on_rhs_intf
    
    S
    
    Returns
  - Defvar
    
    Private
  - Directory
  - Display
  - Display_property
    
    Margin
  - Documentation
    
    Special_sequence
  - Ecaml_profile
    
    Private
  - Echo_area
  - Ediff
  - Elisp_gc
  - Elisp_time
  - Emacs_backtrace
  - Emacs_version
  - Eval
  - Evil
    
    Config
    
    Escape
    
    State
  - Face
    
    Attribute
    
    Packed
    
    Attribute_and_value
    
    Background
    
    Box
    
    Extend
    
    Font
    
    Font_family
    
    Font_foundry
    
    Foreground
    
    Frame
    
    Height
    
    Inherit
    
    Inverse_video
    
    Overline
    
    Slant
    
    Stipple
    
    Strike_through
    
    Underline
    
    Weight
    
    Width
  - Feature
  - File
  - Filename
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Diff
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Set
    
    Diff
    
    Elt
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
  - Find_function
  - Frame
    
    Include_minibuffer
  - Grep
    
    Save_buffers
  - Hash_table
    
    Test
  - Help
  - Hook
    
    Function
    
    Hook_type
    
    Where
    
    Wrap
  - Input_event
    
    Basic
    
    Command_or_key
    
    Modifier
  - Key_sequence
  - Keymap
    
    Entry
    
    Kind
  - Kill_ring
  - Line_and_column
  - Load
  - Load_history
    
    Entry
    
    Face
    
    Attribute
    
    Packed
    
    T
    
    Attribute_and_value
    
    Attribute_value
    
    Background
    
    Box
    
    Color_or_unspecified
    
    Extend
    
    Font
    
    Font_family
    
    Font_foundry
    
    Foreground
    
    Frame
    
    Height
    
    Inherit
    
    Inverse_video
    
    Line
    
    Overline
    
    Q
    
    Slant
    
    T
    
    Stipple
    
    Strike_through
    
    String_name
    
    Underline
    
    Unimplemented
    
    Value
    
    Weight
    
    T
    
    Width
    
    T
    
    Type
  - Major_mode
    
    Asm
    
    Auto_mode
    
    Compare_by_name
    
    Dired
    
    Emacs_lisp
    
    For_testing
    
    Fundamental
    
    Lisp_data
    
    Makefile
    
    Name
    
    Prog
    
    Python
    
    S
    
    S_with_lazy_keymap
    
    Scheme
    
    Special
    
    Text
    
    Tuareg
  - Marker
    
    Insertion_type
  - Minibuffer
    
    History
    
    History_length
    
    Y_or_n_with_timeout
  - Minor_mode
    
    Private
  - Mode_line
    
    Format
  - Modified_tick
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Diff
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Set
    
    Diff
    
    Elt
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
  - Obarray
  - Obsolete
  - Ocaml_or_elisp_value
    
    S
  - Org_table
  - Overlay
  - Plist
  - Point
    
    Property_search
    
    Match
    
    Which
  - Position
    
    Map
    
    Diff
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Set
    
    Diff
    
    Elt
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
  - Print
  - Process
    
    Call
    
    Input
    
    Output
    
    Stderr
    
    Stdout
    
    Region_input
    
    Result
    
    Exit_status
    
    Exited
    
    Status
  - Progress_reporter
    
    Deferred
    
    List
  - Q
    
    K
  - Ref
  - Regexp
    
    Last_match
    
    Private
    
    Location
  - Rx
    
    Char_class
    
    Named_char_class
    
    Start_or_end
  - Selected_window
    
    Blocking
  - Symbol
    
    Automatic_migration
    
    New
    
    Compare_name
    
    Disabled
    
    Make_subtype
    
    Arg
    
    Property
    
    Subtype
  - Symbol_prefix
    
    S
  - Sync_or_async
  - Syntax_table
    
    Class
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Descriptor
    
    Flag
  - System
    
    Var_and_value
  - Tabulated_list
    
    Column
    
    Tabulated_list_mode
  - Terminal
  - Text
    
    Compare_as_string
    
    Map
    
    Diff
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Set
    
    Diff
    
    Elt
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Display_spec
    
    Face_spec
    
    One
    
    Property
    
    Property_name
    
    Create
    
    Packed
  - Thing_at_point
  - Timer
  - User
  - Var
    
    And_value
    
    And_value_option
    
    Wrap
  - Variable_watcher
    
    Event
    
    Operation
  - Vector
  - Window
    
    Blocking
    
    Tree
    
    Direction
  - Working_directory
ecaml.bench
- Ecaml_bench
  - Bench_async_ecaml
ecaml.ecaml_test_helpers
- Ecaml_test_helpers
  - Buffer_helper
    
    Region
    
    Sample_input
ecaml.ecaml_value
- Ecaml_value
  - Caml_embed
  - Ecaml_callback
  - Feature
  - Form
    
    Blocking
  - Funcall
    
    Private
    
    Wrap
  - Function
    
    Expert
    
    Fn
  - Symbol
  - Value
    
    Expert
    
    Process_input
    
    For_testing
    
    Funcall
    
    Make_subtype
    
    Subtype
    
    Make_subtype_arg
    
    Private
    
    Block_on_async
    
    Enqueue_foreground_block_on_async
    
    Run_outside_async
    
    Stat
    
    Subtype
    
    Type
    
    S
  - Valueable
    
    Make
    
    M
    
    S
    
    S1
ecaml.nested_profile
- Nested_profile
  - Profile
    
    Private
    
    Clock
    
    Start_location
    
    Sync_or_async

Legend:
Library
Module
Module type
Parameter
Class
Class type

Idiomatic usage of Wrap looks like:

Var.Wrap.(SYMBOL_NAME <: TYPE)

For example:

Var.Wrap.("inhibit-quit" <: bool)

val (<:) : string -> 'a Ecaml_value.Value.Type.t -> 'a t

include Ecaml_value.Value.Type.S

val create : 
  Core.Sexp.t ->
  ('a -> Core.Sexp.t) ->
  (Ecaml_value.Value.t -> 'a) ->
  ('a -> Ecaml_value.Value.t) ->
  'a Ecaml_value.Value.Type.t

val with_of_value_exn : 
  'a Ecaml_value.Value.Type.t ->
  (Ecaml_value.Value.t -> 'a) ->
  'a Ecaml_value.Value.Type.t

val to_sexp : 'a Ecaml_value.Value.Type.t -> 'a -> Core.Sexp.t

val bool : bool Ecaml_value.Value.Type.t

val float : float Ecaml_value.Value.Type.t

val ignored : unit Ecaml_value.Value.Type.t

val int : int Ecaml_value.Value.Type.t

val string : string Ecaml_value.Value.Type.t

val string_cached : string Ecaml_value.Value.Type.t

string_cached is like string, except it uses of_utf8_bytes_cached.

val unit : unit Ecaml_value.Value.Type.t

val value : Ecaml_value.Value.t Ecaml_value.Value.Type.t

val list : 'a Ecaml_value.Value.Type.t -> 'a list Ecaml_value.Value.Type.t

val vector : 'a Ecaml_value.Value.Type.t -> 'a array Ecaml_value.Value.Type.t

val 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.

val option : 'a Ecaml_value.Value.Type.t -> 'a option Ecaml_value.Value.Type.t

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

val nil_or : 'a Ecaml_value.Value.Type.t -> 'a option Ecaml_value.Value.Type.t

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.

val alist : 
  'a Ecaml_value.Value.Type.t ->
  'b Ecaml_value.Value.Type.t ->
  ('a * 'b) list Ecaml_value.Value.Type.t

val tuple : 
  'a Ecaml_value.Value.Type.t ->
  'b Ecaml_value.Value.Type.t ->
  ('a * 'b) Ecaml_value.Value.Type.t

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

val tuple2_as_list : 
  'a Ecaml_value.Value.Type.t ->
  'b Ecaml_value.Value.Type.t ->
  ('a * 'b) Ecaml_value.Value.Type.t

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

val 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

val 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.