package ocamlformat

  1. Overview
  2. Docs
package ocamlformat
Legend:
Library
Module
Module type
Parameter
Class
Class type

arrow_typ cmts ty returns the list of labeled sub-arrow types of the type ty.

class_arrow_typ cmts ty returns the list of labeled sub_arrow types of the class type ty.

or_pat allow_attribute cmts pat returns the list of patterns of a pattern disjunction. allow_attribute is set by default, otherwise patterns with not empty attributes are not processed (i.e. they are returned without modification).

val fun_ : Cmts.t -> ?will_keep_first_ast_node:Ocamlformat_stdlib.bool -> Extended_ast.expression Ast.xt -> arg_kind Ocamlformat_stdlib.list * Extended_ast.expression Ast.xt

fun_ cmts will_keep_first_ast_node exp returns the list of arguments and the body of the function exp. will_keep_first_ast_node is set by default, otherwise the exp is returned without modification.

cl_fun will_keep_first_ast_node cmts exp returns the list of arguments and the body of the function exp. will_keep_first_ast_node is set by default, otherwise the exp is returned without modification.

module Exp : sig ... end
module Pat : sig ... end

ite cmts exp returns a list of conditional expressions from cascading if-then-else expressions, e.g.:

if c1 then e1 else if c2 then e2 else e3

will return the following list: (Some c1, e1); (Some c2, e2); (None, e3).

sequence cmts exp returns the list of expressions (with the optional extension) from a sequence of expressions exp.

type functor_arg =
  1. | Unit
  2. | Named of Ocaml_413_extended.Asttypes.label Ocamlformat_stdlib.option Ocaml_413_extended.Asttypes.loc * Extended_ast.module_type Ast.xt
    (*

    Equivalent of the functor_parameter type with a contextualized module type.

    *)

functor_type cmts for_functor_kw m returns the list of module types applied to the functor of module type m. for_functor_kw indicates if the keyword functor is used.

val functor_ : Cmts.t -> for_functor_kw:Ocamlformat_stdlib.bool -> source_is_long:(Extended_ast.module_expr -> Ocamlformat_stdlib.bool) -> Extended_ast.module_expr Ast.xt -> functor_arg Ocaml_413_extended.Asttypes.loc Ocamlformat_stdlib.list * Extended_ast.module_expr Ast.xt

functor_ cmts for_functor_kw m returns the list of module types applied to the functor of module m. for_functor_kw indicates if the keyword functor is used.

mod_with m returns the list of with type constraints of module type m.

module Let_binding : sig ... end