package vcaml

  1. Overview
  2. Docs
package vcaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t =
  1. | Command_line_editing
  2. | Confirm_dialog
  3. | External_command
  4. | Hit_enter_prompt
  5. | Insert
  6. | Insert_mode_completion
  7. | Insert_mode_x_completion
  8. | More_prompt
  9. | Normal
  10. | Normal_using_i_ctrl_o_in_insert_mode
  11. | Normal_using_i_ctrl_o_in_replace_mode
  12. | Normal_using_i_ctrl_o_in_virtual_replace_mode
  13. | Normal_ex_mode
  14. | Operator_pending
  15. | Operator_pending_forced_blockwise
  16. | Operator_pending_forced_characterwise
  17. | Operator_pending_forced_linewise
  18. | Replace
  19. | Replace_mode_completion
  20. | Replace_mode_x_completion
  21. | Select_blockwise
  22. | Select_by_character
  23. | Select_by_line
  24. | Terminal
  25. | Vim_ex_mode
  26. | Virtual_replace
  27. | Visual_blockwise
  28. | Visual_by_character
  29. | Visual_by_line

See `:h mode()` for descriptions of these modes.

include Ppx_enumerate_lib.Enumerable.S with type t := t
val all : t list
val sexp_of_t : t -> Sexplib0.Sexp.t
include Core.Comparable.S_plain with type t := t
include Base.Comparable.S with type t := t
include Base.Comparisons.S with type t := t
include Base.Comparisons.Infix with type t := t
val (>=) : t -> t -> bool
val (<=) : t -> t -> bool
val (=) : t -> t -> bool
val (>) : t -> t -> bool
val (<) : t -> t -> bool
val (<>) : t -> t -> bool
val equal : t -> t -> bool
val compare : t -> t -> int

compare t1 t2 returns 0 if t1 is equal to t2, a negative integer if t1 is less than t2, and a positive integer if t1 is greater than t2.

val min : t -> t -> t
val max : t -> t -> t
val ascending : t -> t -> int

ascending is identical to compare. descending x y = ascending y x. These are intended to be mnemonic when used like List.sort ~compare:ascending and List.sort ~cmp:descending, since they cause the list to be sorted in ascending or descending order, respectively.

val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool

between t ~low ~high means low <= t <= high

val clamp_exn : t -> min:t -> max:t -> t

clamp_exn t ~min ~max returns t', the closest value to t such that between t' ~low:min ~high:max is true.

Raises if not (min <= max).

val clamp : t -> min:t -> max:t -> t Base.Or_error.t
include Base.Comparator.S with type t := t
type comparator_witness
val validate_lbound : min:t Core.Maybe_bound.t -> t Validate.check
val validate_ubound : max:t Core.Maybe_bound.t -> t Validate.check
val validate_bound : min:t Core.Maybe_bound.t -> max:t Core.Maybe_bound.t -> t Validate.check
val of_mode_symbol : string -> t Core.Or_error.t
module With_blocking_info : sig ... end