package ocamlformat

  1. Overview
  2. Docs
package ocamlformat
Legend:
Library
Module
Module type
Parameter
Class
Class type
type native_obj_config = {
  1. flambda : bool;
}
val native_obj_config : native_obj_config
type version = int
type kind =
  1. | Exec
  2. | Cmi
  3. | Cmo
  4. | Cma
  5. | Cmx of native_obj_config
  6. | Cmxa of native_obj_config
  7. | Cmxs
  8. | Cmt
  9. | Ast_impl
  10. | Ast_intf
type info = {
  1. kind : kind;
  2. version : version;
}
type raw = string
type parse_error =
  1. | Truncated of string
  2. | Not_a_magic_number of string
val explain_parse_error : kind option -> parse_error -> string
val parse : raw -> (info, parse_error) Stdlib.result
val read_info : Stdlib.in_channel -> (info, parse_error) Stdlib.result
val magic_length : int
type !'a unexpected = {
  1. expected : 'a;
  2. actual : 'a;
}
type unexpected_error =
  1. | Kind of kind unexpected
  2. | Version of kind * version unexpected
val check_current : kind -> info -> (unit, unexpected_error) Stdlib.result
val explain_unexpected_error : unexpected_error -> string
type error =
  1. | Parse_error of parse_error
  2. | Unexpected_error of unexpected_error
val read_current_info : expected_kind:kind option -> Stdlib.in_channel -> (info, error) Stdlib.result
val string_of_kind : kind -> string
val human_name_of_kind : kind -> string
val current_raw : kind -> raw
val current_version : kind -> version
type raw_kind = string
val parse_kind : raw_kind -> kind option
val raw_kind : kind -> raw_kind
val raw : info -> raw
val all_kinds : kind list