package ocamlformat-lib

  1. Overview
  2. Docs
package ocamlformat-lib
Legend:
Library
Module
Module type
Parameter
Class
Class type
type box_type =
  1. | H
  2. | V
  3. | HV
  4. | HoV
  5. | B
type stag = Format.stag
type element =
  1. | Text of string
  2. | With_size of int
  3. | Open_box of {
    1. kind : box_type;
    2. indent : int;
    }
  4. | Close_box
  5. | Open_tag of Format.stag
  6. | Close_tag
  7. | Open_tbox
  8. | Tab_break of {
    1. width : int;
    2. offset : int;
    }
  9. | Set_tab
  10. | Close_tbox
  11. | Simple_break of {
    1. spaces : int;
    2. indent : int;
    }
  12. | Break of {
    1. fits : (string * int * string) as 'a;
    2. breaks : 'a;
    }
  13. | Flush of {
    1. newline : bool;
    }
  14. | Newline
  15. | If_newline
  16. | Deprecated of Format.formatter -> unit
type t = {
  1. rev : element list;
}
val empty : t
val to_list : t -> element list
val add : t -> element -> t
val fold : ('a -> element -> 'a) -> 'a -> t -> 'a
val append : t -> t -> t
val format_open_box_gen : Format.formatter -> box_type -> int -> unit
val interpret_elt : Format.formatter -> element -> unit
val interpret : Format.formatter -> element list -> unit
val format : Format.formatter -> t -> unit
val open_box : box_type -> int -> t -> t
val close_box : t -> t
val string : string -> t -> t
val bytes : bytes -> t -> t
val with_size : int -> t -> t
val int : int -> t -> t
val float : float -> t -> t
val char : char -> t -> t
val bool : bool -> t -> t
val break : spaces:int -> indent:int -> t -> t
val space : t -> t
val cut : t -> t
val custom_break : fits:(string * int * string) -> breaks:(string * int * string) -> t -> t
val force_newline : t -> t
val if_newline : t -> t
val flush : t -> t
val force_stop : t -> t
val open_tbox : t -> t
val set_tab : t -> t
val tab_break : width:int -> offset:int -> t -> t
val tab : t -> t
val close_tbox : t -> t
val open_tag : Format.stag -> t -> t
val close_tag : t -> t
val iter : ?sep:('a -> 'a) -> iter:(('b -> unit) -> 'c -> 'd) -> ('b -> 'a -> 'a) -> 'c -> 'a -> 'a
val list : ?sep:('a -> 'a) -> ('b -> 'a -> 'a) -> 'b list -> 'a -> 'a
val array : ?sep:('a -> 'a) -> ('b -> 'a -> 'a) -> 'b array -> 'a -> 'a
val seq : ?sep:('a -> 'a) -> ('b -> 'a -> 'a) -> 'b Seq.t -> 'a -> 'a
val option : ?none:('a -> 'a) -> ('b -> 'a -> 'a) -> 'b option -> 'a -> 'a
val either : left:('a -> 'b -> 'c) -> right:('d -> 'b -> 'c) -> ('a, 'd) Ocamlformat_stdlib_shims.Either.t -> 'b -> 'c
val result : ok:('a -> 'b -> 'c) -> error:('d -> 'b -> 'c) -> ('a, 'd) result -> 'b -> 'c
val subtext : int -> int -> int -> string -> t -> t
val text : string -> t -> t
type ('a, 'b) fmt = ('a, t, t, 'b) format4
type printer0 = t -> t
type 'a printer = 'a -> printer0
val output_formatting_lit : CamlinternalFormatBasics.formatting_lit -> t -> t
val to_string : t -> string
val compose_acc : (t, t) CamlinternalFormat.acc -> t -> t
val kprintf : (t -> 'a) -> ('b, t, t, t, t, t -> 'a) CamlinternalFormatBasics.format6 -> 'b
val printf : ('a, t, t, t, t, t -> t) CamlinternalFormatBasics.format6 -> 'a
val kmsg : (t -> 'a) -> ('b, t, t, t, t, 'a) CamlinternalFormatBasics.format6 -> 'b
val msg : ('a, t, t, t, t, t) CamlinternalFormatBasics.format6 -> 'a
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct