package ocamlformat-lib

  1. Overview
  2. Docs
Auto-formatter for OCaml code

Install 

dune-project
 Dependency

github.com Readme Changelog MIT; LGPL-2.1-only WITH OCaml-LGPL-linking-exception License Edit opam file Versions (6)

Authors

  1. J
    Josh Berdine <jjb@fb.com>

Maintainers

  1. O
    OCamlFormat Team <ocamlformat-dev@lists.ocaml.org>

Sources

ocamlformat-0.25.1.tbz
sha256=dc8f2a330ca3930b36cacb2623bb360ed8bdf6e4a8acd293dbd9e2241a6fd33d
sha512=b28f545425fb5375447c90022d065dc7fd51ed2f66d8c1f65a71a6ad2465d039a8686e8f18249e5ad3a2362fee6149c855ef30eb45fb9d06d743a53d26b3e26f

doc/ocamlformat-lib.ocamlformat_stdlib/Ocamlformat_stdlib/index.html

Module Ocamlformat_stdlibSource

include module type of Base
Sourcemodule Applicative = Base.Applicative
Sourcemodule Array = Base.Array
Sourcemodule Avltree = Base.Avltree
Sourcemodule Backtrace = Base.Backtrace
Sourcemodule Binary_searchable = Base.Binary_searchable
Sourcemodule Blit = Base.Blit
Sourcemodule Bool = Base.Bool
Sourcemodule Buffer = Base.Buffer
Sourcemodule Bytes = Base.Bytes
Sourcemodule Char = Base.Char
Sourcemodule Comparable = Base.Comparable
Sourcemodule Comparator = Base.Comparator
Sourcemodule Comparisons = Base.Comparisons
Sourcemodule Container = Base.Container
Sourcemodule Either = Base.Either
Sourcemodule Equal = Base.Equal
Sourcemodule Error = Base.Error
Sourcemodule Exn = Base.Exn
Sourcemodule Field = Base.Field
Sourcemodule Float = Base.Float
Sourcemodule Floatable = Base.Floatable
Sourcemodule Fn = Base.Fn
Sourcemodule Formatter = Base.Formatter
Sourcemodule Hash = Base.Hash
Sourcemodule Hash_set = Base.Hash_set
Sourcemodule Hashable = Base.Hashable
Sourcemodule Hasher = Base.Hasher
Sourcemodule Hashtbl = Base.Hashtbl
Sourcemodule Identifiable = Base.Identifiable
Sourcemodule Indexed_container = Base.Indexed_container
Sourcemodule Info = Base.Info
Sourcemodule Int = Base.Int
Sourcemodule Int32 = Base.Int32
Sourcemodule Int63 = Base.Int63
Sourcemodule Int64 = Base.Int64
Sourcemodule Intable = Base.Intable
Sourcemodule Int_math = Base.Int_math
Sourcemodule Invariant = Base.Invariant
Sourcemodule Dictionary_immutable = Base.Dictionary_immutable
Sourcemodule Dictionary_mutable = Base.Dictionary_mutable
Sourcemodule Lazy = Base.Lazy
Sourcemodule Map = Base.Map
Sourcemodule Maybe_bound = Base.Maybe_bound
Sourcemodule Monad = Base.Monad
Sourcemodule Nativeint = Base.Nativeint
Sourcemodule Nothing = Base.Nothing
Sourcemodule Option = Base.Option
Sourcemodule Option_array = Base.Option_array
Sourcemodule Or_error = Base.Or_error
Sourcemodule Ordered_collection_common = Base.Ordered_collection_common
Sourcemodule Ordering = Base.Ordering
Sourcemodule Poly = Base.Poly
Sourcemodule Pretty_printer = Base.Pretty_printer
Sourcemodule Printf = Base.Printf
Sourcemodule Linked_queue = Base.Linked_queue
Sourcemodule Queue = Base.Queue
Sourcemodule Random = Base.Random
Sourcemodule Ref = Base.Ref
Sourcemodule Result = Base.Result
Sourcemodule Sequence = Base.Sequence
Sourcemodule Set = Base.Set
Sourcemodule Sexpable = Base.Sexpable
Sourcemodule Sign = Base.Sign
Sourcemodule Sign_or_nan = Base.Sign_or_nan
Sourcemodule Source_code_position = Base.Source_code_position
Sourcemodule Stack = Base.Stack
Sourcemodule Staged = Base.Staged
Sourcemodule Stringable = Base.Stringable
Sourcemodule Sys = Base.Sys
Sourcemodule T = Base.T
Sourcemodule Type_equal = Base.Type_equal
Sourcemodule Uniform_array = Base.Uniform_array
Sourcemodule Unit = Base.Unit
Sourcemodule Uchar = Base.Uchar
Sourcemodule Variant = Base.Variant
Sourcemodule With_return = Base.With_return
Sourcemodule Word_size = Base.Word_size
include module type of struct include T end
Sourcemodule type T = T.T
Sourcemodule type T1 = T.T1
Sourcemodule type T2 = T.T2
Sourcemodule type T3 = T.T3
Sourcemodule Sexp : sig ... end
Sourcemodule Int_conversions : sig ... end
Sourcemodule Export : sig ... end
include module type of struct include Export end
Sourcetype 'a array = 'a Array.t
Sourceval compare_array__local : 'a. ('a -> 'a -> int) -> 'a array -> 'a array -> int
Sourceval compare_array : 'a. ('a -> 'a -> int) -> 'a array -> 'a array -> int
Sourceval equal_array__local : 'a. ('a -> 'a -> bool) -> 'a array -> 'a array -> bool
Sourceval equal_array : 'a. ('a -> 'a -> bool) -> 'a array -> 'a array -> bool
Sourceval globalize_array : 'a. ('a -> 'a) -> 'a array -> 'a array
Sourceval array_of_sexp : 'a. (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a array
Sourceval sexp_of_array : 'a. ('a -> Sexplib0.Sexp.t) -> 'a array -> Sexplib0.Sexp.t
Sourceval array_sexp_grammar : 'a. 'a Sexplib0.Sexp_grammar.t -> 'a array Sexplib0.Sexp_grammar.t
Sourcetype bool = Bool.t
Sourceval compare_bool__local : bool -> bool -> int
Sourceval compare_bool : bool -> bool -> int
Sourceval equal_bool__local : bool -> bool -> bool
Sourceval equal_bool : bool -> bool -> bool
Sourceval globalize_bool : bool -> bool
Sourceval hash_fold_bool : Base.Hash.state -> bool -> Base.Hash.state
Sourceval hash_bool : bool -> Base.Hash.hash_value
Sourceval bool_of_sexp : Sexplib0.Sexp.t -> bool
Sourceval sexp_of_bool : bool -> Sexplib0.Sexp.t
Sourceval bool_sexp_grammar : bool Sexplib0.Sexp_grammar.t
Sourcetype char = Char.t
Sourceval compare_char__local : char -> char -> int
Sourceval compare_char : char -> char -> int
Sourceval equal_char__local : char -> char -> bool
Sourceval equal_char : char -> char -> bool
Sourceval globalize_char : char -> char
Sourceval hash_fold_char : Base.Hash.state -> char -> Base.Hash.state
Sourceval hash_char : char -> Base.Hash.hash_value
Sourceval char_of_sexp : Sexplib0.Sexp.t -> char
Sourceval sexp_of_char : char -> Sexplib0.Sexp.t
Sourceval char_sexp_grammar : char Sexplib0.Sexp_grammar.t
Sourcetype exn = Exn.t
Sourceval sexp_of_exn : exn -> Sexplib0.Sexp.t
Sourcetype float = Float.t
Sourceval compare_float__local : float -> float -> int
Sourceval compare_float : float -> float -> int
Sourceval equal_float__local : float -> float -> bool
Sourceval equal_float : float -> float -> bool
Sourceval globalize_float : float -> float
Sourceval hash_fold_float : Base.Hash.state -> float -> Base.Hash.state
Sourceval hash_float : float -> Base.Hash.hash_value
Sourceval float_of_sexp : Sexplib0.Sexp.t -> float
Sourceval sexp_of_float : float -> Sexplib0.Sexp.t
Sourceval float_sexp_grammar : float Sexplib0.Sexp_grammar.t
Sourcetype int = Int.t
Sourceval compare_int__local : int -> int -> int
Sourceval compare_int : int -> int -> int
Sourceval equal_int__local : int -> int -> bool
Sourceval equal_int : int -> int -> bool
Sourceval globalize_int : int -> int
Sourceval hash_fold_int : Base.Hash.state -> int -> Base.Hash.state
Sourceval int_of_sexp : Sexplib0.Sexp.t -> int
Sourceval sexp_of_int : int -> Sexplib0.Sexp.t
Sourceval int_sexp_grammar : int Sexplib0.Sexp_grammar.t
Sourcetype int32 = Int32.t
Sourceval compare_int32__local : int32 -> int32 -> int
Sourceval compare_int32 : int32 -> int32 -> int
Sourceval equal_int32__local : int32 -> int32 -> bool
Sourceval equal_int32 : int32 -> int32 -> bool
Sourceval globalize_int32 : int32 -> int32
Sourceval hash_fold_int32 : Base.Hash.state -> int32 -> Base.Hash.state
Sourceval hash_int32 : int32 -> Base.Hash.hash_value
Sourceval int32_of_sexp : Sexplib0.Sexp.t -> int32
Sourceval sexp_of_int32 : int32 -> Sexplib0.Sexp.t
Sourceval int32_sexp_grammar : int32 Sexplib0.Sexp_grammar.t
Sourcetype int64 = Int64.t
Sourceval compare_int64__local : int64 -> int64 -> int
Sourceval compare_int64 : int64 -> int64 -> int
Sourceval equal_int64__local : int64 -> int64 -> bool
Sourceval equal_int64 : int64 -> int64 -> bool
Sourceval globalize_int64 : int64 -> int64
Sourceval hash_fold_int64 : Base.Hash.state -> int64 -> Base.Hash.state
Sourceval hash_int64 : int64 -> Base.Hash.hash_value
Sourceval int64_of_sexp : Sexplib0.Sexp.t -> int64
Sourceval sexp_of_int64 : int64 -> Sexplib0.Sexp.t
Sourceval int64_sexp_grammar : int64 Sexplib0.Sexp_grammar.t
Sourcetype 'a list = 'a Base.List.t
Sourceval compare_list__local : 'a. ('a -> 'a -> int) -> 'a list -> 'a list -> int
Sourceval compare_list : 'a. ('a -> 'a -> int) -> 'a list -> 'a list -> int
Sourceval equal_list__local : 'a. ('a -> 'a -> bool) -> 'a list -> 'a list -> bool
Sourceval equal_list : 'a. ('a -> 'a -> bool) -> 'a list -> 'a list -> bool
Sourceval globalize_list : 'a. ('a -> 'a) -> 'a list -> 'a list
Sourceval hash_fold_list : 'a. (Base.Hash.state -> 'a -> Base.Hash.state) -> Base.Hash.state -> 'a list -> Base.Hash.state
Sourceval list_of_sexp : 'a. (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a list
Sourceval sexp_of_list : 'a. ('a -> Sexplib0.Sexp.t) -> 'a list -> Sexplib0.Sexp.t
Sourceval list_sexp_grammar : 'a. 'a Sexplib0.Sexp_grammar.t -> 'a list Sexplib0.Sexp_grammar.t
Sourcetype nativeint = Nativeint.t
Sourceval compare_nativeint__local : nativeint -> nativeint -> int
Sourceval compare_nativeint : nativeint -> nativeint -> int
Sourceval equal_nativeint__local : nativeint -> nativeint -> bool
Sourceval equal_nativeint : nativeint -> nativeint -> bool
Sourceval globalize_nativeint : nativeint -> nativeint
Sourceval hash_fold_nativeint : Base.Hash.state -> nativeint -> Base.Hash.state
Sourceval hash_nativeint : nativeint -> Base.Hash.hash_value
Sourceval nativeint_of_sexp : Sexplib0.Sexp.t -> nativeint
Sourceval sexp_of_nativeint : nativeint -> Sexplib0.Sexp.t
Sourceval nativeint_sexp_grammar : nativeint Sexplib0.Sexp_grammar.t
Sourcetype 'a option = 'a Option.t
Sourceval compare_option__local : 'a. ('a -> 'a -> int) -> 'a option -> 'a option -> int
Sourceval compare_option : 'a. ('a -> 'a -> int) -> 'a option -> 'a option -> int
Sourceval equal_option__local : 'a. ('a -> 'a -> bool) -> 'a option -> 'a option -> bool
Sourceval equal_option : 'a. ('a -> 'a -> bool) -> 'a option -> 'a option -> bool
Sourceval globalize_option : 'a. ('a -> 'a) -> 'a option -> 'a option
Sourceval hash_fold_option : 'a. (Base.Hash.state -> 'a -> Base.Hash.state) -> Base.Hash.state -> 'a option -> Base.Hash.state
Sourceval option_of_sexp : 'a. (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a option
Sourceval sexp_of_option : 'a. ('a -> Sexplib0.Sexp.t) -> 'a option -> Sexplib0.Sexp.t
Sourceval option_sexp_grammar : 'a. 'a Sexplib0.Sexp_grammar.t -> 'a option Sexplib0.Sexp_grammar.t
Sourcetype 'a ref = 'a Ref.t
Sourceval compare_ref__local : 'a. ('a -> 'a -> int) -> 'a ref -> 'a ref -> int
Sourceval compare_ref : 'a. ('a -> 'a -> int) -> 'a ref -> 'a ref -> int
Sourceval equal_ref__local : 'a. ('a -> 'a -> bool) -> 'a ref -> 'a ref -> bool
Sourceval equal_ref : 'a. ('a -> 'a -> bool) -> 'a ref -> 'a ref -> bool
Sourceval globalize_ref : 'a. ('a -> 'a) -> 'a ref -> 'a ref
Sourceval ref_of_sexp : 'a. (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a ref
Sourceval sexp_of_ref : 'a. ('a -> Sexplib0.Sexp.t) -> 'a ref -> Sexplib0.Sexp.t
Sourceval ref_sexp_grammar : 'a. 'a Sexplib0.Sexp_grammar.t -> 'a ref Sexplib0.Sexp_grammar.t
Sourcetype string = Base.String.t
Sourceval compare_string__local : string -> string -> int
Sourceval compare_string : string -> string -> int
Sourceval equal_string__local : string -> string -> bool
Sourceval equal_string : string -> string -> bool
Sourceval globalize_string : string -> string
Sourceval hash_fold_string : Base.Hash.state -> string -> Base.Hash.state
Sourceval hash_string : string -> Base.Hash.hash_value
Sourceval string_of_sexp : Sexplib0.Sexp.t -> string
Sourceval sexp_of_string : string -> Sexplib0.Sexp.t
Sourceval string_sexp_grammar : string Sexplib0.Sexp_grammar.t
Sourcetype bytes = Bytes.t
Sourceval compare_bytes__local : bytes -> bytes -> int
Sourceval compare_bytes : bytes -> bytes -> int
Sourceval equal_bytes__local : bytes -> bytes -> bool
Sourceval equal_bytes : bytes -> bytes -> bool
Sourceval globalize_bytes : bytes -> bytes
Sourceval bytes_of_sexp : Sexplib0.Sexp.t -> bytes
Sourceval sexp_of_bytes : bytes -> Sexplib0.Sexp.t
Sourceval bytes_sexp_grammar : bytes Sexplib0.Sexp_grammar.t
Sourcetype unit = Unit.t
Sourceval compare_unit__local : unit -> unit -> int
Sourceval compare_unit : unit -> unit -> int
Sourceval equal_unit__local : unit -> unit -> bool
Sourceval equal_unit : unit -> unit -> bool
Sourceval globalize_unit : unit -> unit
Sourceval hash_fold_unit : Base.Hash.state -> unit -> Base.Hash.state
Sourceval hash_unit : unit -> Base.Hash.hash_value
Sourceval unit_of_sexp : Sexplib0.Sexp.t -> unit
Sourceval sexp_of_unit : unit -> Sexplib0.Sexp.t
Sourceval unit_sexp_grammar : unit Sexplib0.Sexp_grammar.t

Format stuff

Sourcetype nonrec ('a, 'b, 'c) format = ('a, 'b, 'c) format
Sourcetype nonrec ('a, 'b, 'c, 'd) format4 = ('a, 'b, 'c, 'd) format4
Sourcetype nonrec ('a, 'b, 'c, 'd, 'e, 'f) format6 = ('a, 'b, 'c, 'd, 'e, 'f) format6

List operators

include module type of struct include Base.List.Infix end
Sourceval (@) : 'a Base.List.t -> 'a Base.List.t -> 'a Base.List.t

Int operators and comparisons

include module type of struct include Int.O end
Sourceval zero : Base.Int.t
Sourceval (//) : Base.Int.t -> Base.Int.t -> float
Sourceval (lsl) : Base.Int.t -> int -> Base.Int.t
Sourceval (asr) : Base.Int.t -> int -> Base.Int.t
Sourceval (lsr) : Base.Int.t -> int -> Base.Int.t
Sourceval (=) : int -> int -> bool
Sourceval (<>) : int -> int -> bool
Sourceval (<) : int -> int -> bool
Sourceval (>) : int -> int -> bool
Sourceval (<=) : int -> int -> bool
Sourceval (>=) : int -> int -> bool
Sourceval compare : int -> int -> int
Sourceval compare__local : int -> int -> int
Sourceval equal : int -> int -> bool
Sourceval equal__local : int -> int -> bool
Sourceval ascending : int -> int -> int
Sourceval descending : int -> int -> int
Sourceval max : int -> int -> int
Sourceval min : int -> int -> int

Float operators

include module type of struct include Float.O_dot end
Sourceval (|>) : 'a -> ('a -> 'b) -> 'b

Reverse application operator. x |> g |> f is equivalent to f (g (x)).

Sourceval (@@) : ('a -> 'b) -> 'a -> 'b

Application operator. g @@ f @@ x is equivalent to g (f (x)).

Boolean operations

Sourceval (&&) : bool -> bool -> bool
Sourceval (||) : bool -> bool -> bool
Sourceval not : bool -> bool
Sourceval ignore : _ -> unit

Common string operations

Reference operations

Sourceval (!) : 'a ref -> 'a
Sourceval ref : 'a -> 'a ref
Sourceval (:=) : 'a ref -> 'a -> unit

Pair operations

Sourceval fst : ('a * 'b) -> 'a
Sourceval snd : ('a * 'b) -> 'b

Exceptions stuff

Sourceval raise : exn -> _
Sourceval failwith : string -> 'a
Sourceval invalid_arg : string -> 'a
Sourceval raise_s : Base.Sexp.t -> 'a

Misc

Sourceval phys_equal : 'a -> 'a -> bool
Sourceval force : 'a Lazy.t -> 'a
Sourcemodule Continue_or_stop = Container.Continue_or_stop

Continue_or_stop.t is used by the f argument to fold_until in order to indicate whether folding should continue, or stop early.

Sourceexception Not_found_s of Sexplib0.Sexp.t
Sourcemodule Caml : sig ... end
include module type of Stdio
Sourcemodule In_channel = Stdio.In_channel
Sourcemodule Out_channel = Stdio.Out_channel
Sourceval stdin : In_channel.t

Same as In_channel.stdin

Sourceval stdout : Out_channel.t

Same as Out_channel.stdout

Sourceval stderr : Out_channel.t

Same as Out_channel.stderr

Sourceval printf : ('a, Out_channel.t, Base.unit) Base.format -> 'a

Same as Out_channel.printf

Sourceval print_s : ?mach:Base.unit -> Base.Sexp.t -> Base.unit

Same as Out_channel.print_s

Sourceval eprint_s : ?mach:Base.unit -> Base.Sexp.t -> Base.unit

Same as Out_channel.eprint_s

Sourceval eprintf : ('a, Out_channel.t, Base.unit) Base.format -> 'a

Same as Out_channel.eprintf

Sourceval print_string : Base.string -> Base.unit

Same as Out_channel.print_string

Sourceval print_endline : Base.string -> Base.unit

Same as Out_channel.print_endline

Sourceval prerr_endline : Base.string -> Base.unit

Same as Out_channel.prerr_endline

Sourcemodule Fpath : sig ... end
Sourcemodule List : sig ... end
Sourcemodule String : sig ... end
Sourcemodule Warning : sig ... end
Sourcemodule Format = Format
Sourcemodule Filename = Filename
Sourceval (>>) : ('a -> 'b) -> ('b -> 'c) -> 'a -> 'c

Composition of functions: (f >> g) x is exactly equivalent to g (f (x)). Left associative.

Sourceval impossible : string -> _

Indicate why the call is expected to be impossible.

Sourceval check : ('a -> _) -> 'a -> 'a

Asserting identity: check f x asserts that f x does not raise and returns x.