package ocamlformat-lib

  1. Overview
  2. Docs
package ocamlformat-lib
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Format_doc.DocSource

Sourcetype box_type =
  1. | H
  2. | V
  3. | HV
  4. | HoV
  5. | B
Sourcetype stag = Format.stag
Sourcetype 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
Sourcetype t = {
  1. rev : element list;
}
Sourceval empty : t
Sourceval to_list : t -> element list
Sourceval add : t -> element -> t
Sourceval fold : ('a -> element -> 'a) -> 'a -> t -> 'a
Sourceval append : t -> t -> t
Sourceval format_open_box_gen : Format.formatter -> box_type -> int -> unit
Sourceval interpret_elt : Format.formatter -> element -> unit
Sourceval interpret : Format.formatter -> element list -> unit
Sourceval format : Format.formatter -> t -> unit
Sourceval open_box : box_type -> int -> t -> t
Sourceval close_box : t -> t
Sourceval string : string -> t -> t
Sourceval bytes : bytes -> t -> t
Sourceval with_size : int -> t -> t
Sourceval int : int -> t -> t
Sourceval float : float -> t -> t
Sourceval char : char -> t -> t
Sourceval bool : bool -> t -> t
Sourceval break : spaces:int -> indent:int -> t -> t
Sourceval space : t -> t
Sourceval cut : t -> t
Sourceval custom_break : fits:(string * int * string) -> breaks:(string * int * string) -> t -> t
Sourceval force_newline : t -> t
Sourceval if_newline : t -> t
Sourceval flush : t -> t
Sourceval force_stop : t -> t
Sourceval open_tbox : t -> t
Sourceval set_tab : t -> t
Sourceval tab_break : width:int -> offset:int -> t -> t
Sourceval tab : t -> t
Sourceval close_tbox : t -> t
Sourceval open_tag : Format.stag -> t -> t
Sourceval close_tag : t -> t
Sourceval iter : ?sep:('a -> 'a) -> iter:(('b -> unit) -> 'c -> 'd) -> ('b -> 'a -> 'a) -> 'c -> 'a -> 'a
Sourceval list : ?sep:('a -> 'a) -> ('b -> 'a -> 'a) -> 'b list -> 'a -> 'a
Sourceval array : ?sep:('a -> 'a) -> ('b -> 'a -> 'a) -> 'b array -> 'a -> 'a
Sourceval seq : ?sep:('a -> 'a) -> ('b -> 'a -> 'a) -> 'b Seq.t -> 'a -> 'a
Sourceval option : ?none:('a -> 'a) -> ('b -> 'a -> 'a) -> 'b option -> 'a -> 'a
Sourceval either : left:('a -> 'b -> 'c) -> right:('d -> 'b -> 'c) -> ('a, 'd) Ocamlformat_stdlib_shims.Either.t -> 'b -> 'c
Sourceval result : ok:('a -> 'b -> 'c) -> error:('d -> 'b -> 'c) -> ('a, 'd) result -> 'b -> 'c
Sourceval subtext : int -> int -> int -> string -> t -> t
Sourceval text : string -> t -> t
Sourcetype ('a, 'b) fmt = ('a, t, t, 'b) format4
Sourcetype printer0 = t -> t
Sourcetype 'a printer = 'a -> printer0
Sourceval output_formatting_lit : CamlinternalFormatBasics.formatting_lit -> t -> t
Sourceval to_string : t -> string
Sourceval compose_acc : (t, t) CamlinternalFormat.acc -> t -> t
Sourceval kprintf : (t -> 'a) -> ('b, t, t, t, t, t -> 'a) CamlinternalFormatBasics.format6 -> 'b
Sourceval printf : ('a, t, t, t, t, t -> t) CamlinternalFormatBasics.format6 -> 'a
Sourceval kmsg : (t -> 'a) -> ('b, t, t, t, t, 'a) CamlinternalFormatBasics.format6 -> 'b
Sourceval 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