package ocamlformat-lib

  1. Overview
  2. Docs
package ocamlformat-lib
Legend:
Library
Module
Module type
Parameter
Class
Class type
type 'a array = 'a Array.t
val compare_array__local : 'a. ('a -> 'a -> int) -> 'a array -> 'a array -> int
val compare_array : 'a. ('a -> 'a -> int) -> 'a array -> 'a array -> int
val equal_array__local : 'a. ('a -> 'a -> bool) -> 'a array -> 'a array -> bool
val equal_array : 'a. ('a -> 'a -> bool) -> 'a array -> 'a array -> bool
val globalize_array : 'a. ('a -> 'a) -> 'a array -> 'a array
val array_of_sexp : 'a. (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a array
val sexp_of_array : 'a. ('a -> Sexplib0.Sexp.t) -> 'a array -> Sexplib0.Sexp.t
val array_sexp_grammar : 'a. 'a Sexplib0.Sexp_grammar.t -> 'a array Sexplib0.Sexp_grammar.t
type bool = Bool.t
val compare_bool__local : bool -> bool -> int
val compare_bool : bool -> bool -> int
val equal_bool__local : bool -> bool -> bool
val equal_bool : bool -> bool -> bool
val globalize_bool : bool -> bool
val hash_fold_bool : Base.Hash.state -> bool -> Base.Hash.state
val hash_bool : bool -> Base.Hash.hash_value
val bool_of_sexp : Sexplib0.Sexp.t -> bool
val sexp_of_bool : bool -> Sexplib0.Sexp.t
val bool_sexp_grammar : bool Sexplib0.Sexp_grammar.t
type char = Char.t
val compare_char__local : char -> char -> int
val compare_char : char -> char -> int
val equal_char__local : char -> char -> bool
val equal_char : char -> char -> bool
val globalize_char : char -> char
val hash_fold_char : Base.Hash.state -> char -> Base.Hash.state
val hash_char : char -> Base.Hash.hash_value
val char_of_sexp : Sexplib0.Sexp.t -> char
val sexp_of_char : char -> Sexplib0.Sexp.t
val char_sexp_grammar : char Sexplib0.Sexp_grammar.t
type exn = Exn.t
val sexp_of_exn : exn -> Sexplib0.Sexp.t
type float = Float.t
val compare_float__local : float -> float -> int
val compare_float : float -> float -> int
val equal_float__local : float -> float -> bool
val equal_float : float -> float -> bool
val globalize_float : float -> float
val hash_fold_float : Base.Hash.state -> float -> Base.Hash.state
val hash_float : float -> Base.Hash.hash_value
val float_of_sexp : Sexplib0.Sexp.t -> float
val sexp_of_float : float -> Sexplib0.Sexp.t
val float_sexp_grammar : float Sexplib0.Sexp_grammar.t
type int = Int.t
val compare_int__local : int -> int -> int
val compare_int : int -> int -> int
val equal_int__local : int -> int -> bool
val equal_int : int -> int -> bool
val globalize_int : int -> int
val hash_fold_int : Base.Hash.state -> int -> Base.Hash.state
val hash_int : int -> Base.Hash.hash_value
val int_of_sexp : Sexplib0.Sexp.t -> int
val sexp_of_int : int -> Sexplib0.Sexp.t
val int_sexp_grammar : int Sexplib0.Sexp_grammar.t
type int32 = Int32.t
val compare_int32__local : int32 -> int32 -> int
val compare_int32 : int32 -> int32 -> int
val equal_int32__local : int32 -> int32 -> bool
val equal_int32 : int32 -> int32 -> bool
val globalize_int32 : int32 -> int32
val hash_fold_int32 : Base.Hash.state -> int32 -> Base.Hash.state
val hash_int32 : int32 -> Base.Hash.hash_value
val int32_of_sexp : Sexplib0.Sexp.t -> int32
val sexp_of_int32 : int32 -> Sexplib0.Sexp.t
val int32_sexp_grammar : int32 Sexplib0.Sexp_grammar.t
type int64 = Int64.t
val compare_int64__local : int64 -> int64 -> int
val compare_int64 : int64 -> int64 -> int
val equal_int64__local : int64 -> int64 -> bool
val equal_int64 : int64 -> int64 -> bool
val globalize_int64 : int64 -> int64
val hash_fold_int64 : Base.Hash.state -> int64 -> Base.Hash.state
val hash_int64 : int64 -> Base.Hash.hash_value
val int64_of_sexp : Sexplib0.Sexp.t -> int64
val sexp_of_int64 : int64 -> Sexplib0.Sexp.t
val int64_sexp_grammar : int64 Sexplib0.Sexp_grammar.t
type 'a list = 'a Base.List.t
val compare_list__local : 'a. ('a -> 'a -> int) -> 'a list -> 'a list -> int
val compare_list : 'a. ('a -> 'a -> int) -> 'a list -> 'a list -> int
val equal_list__local : 'a. ('a -> 'a -> bool) -> 'a list -> 'a list -> bool
val equal_list : 'a. ('a -> 'a -> bool) -> 'a list -> 'a list -> bool
val globalize_list : 'a. ('a -> 'a) -> 'a list -> 'a list
val hash_fold_list : 'a. (Base.Hash.state -> 'a -> Base.Hash.state) -> Base.Hash.state -> 'a list -> Base.Hash.state
val list_of_sexp : 'a. (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a list
val sexp_of_list : 'a. ('a -> Sexplib0.Sexp.t) -> 'a list -> Sexplib0.Sexp.t
val list_sexp_grammar : 'a. 'a Sexplib0.Sexp_grammar.t -> 'a list Sexplib0.Sexp_grammar.t
type nativeint = Nativeint.t
val compare_nativeint__local : nativeint -> nativeint -> int
val compare_nativeint : nativeint -> nativeint -> int
val equal_nativeint__local : nativeint -> nativeint -> bool
val equal_nativeint : nativeint -> nativeint -> bool
val globalize_nativeint : nativeint -> nativeint
val hash_fold_nativeint : Base.Hash.state -> nativeint -> Base.Hash.state
val hash_nativeint : nativeint -> Base.Hash.hash_value
val nativeint_of_sexp : Sexplib0.Sexp.t -> nativeint
val sexp_of_nativeint : nativeint -> Sexplib0.Sexp.t
val nativeint_sexp_grammar : nativeint Sexplib0.Sexp_grammar.t
type 'a option = 'a Option.t
val compare_option__local : 'a. ('a -> 'a -> int) -> 'a option -> 'a option -> int
val compare_option : 'a. ('a -> 'a -> int) -> 'a option -> 'a option -> int
val equal_option__local : 'a. ('a -> 'a -> bool) -> 'a option -> 'a option -> bool
val equal_option : 'a. ('a -> 'a -> bool) -> 'a option -> 'a option -> bool
val globalize_option : 'a. ('a -> 'a) -> 'a option -> 'a option
val hash_fold_option : 'a. (Base.Hash.state -> 'a -> Base.Hash.state) -> Base.Hash.state -> 'a option -> Base.Hash.state
val option_of_sexp : 'a. (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a option
val sexp_of_option : 'a. ('a -> Sexplib0.Sexp.t) -> 'a option -> Sexplib0.Sexp.t
val option_sexp_grammar : 'a. 'a Sexplib0.Sexp_grammar.t -> 'a option Sexplib0.Sexp_grammar.t
type 'a ref = 'a Ref.t
val compare_ref__local : 'a. ('a -> 'a -> int) -> 'a ref -> 'a ref -> int
val compare_ref : 'a. ('a -> 'a -> int) -> 'a ref -> 'a ref -> int
val equal_ref__local : 'a. ('a -> 'a -> bool) -> 'a ref -> 'a ref -> bool
val equal_ref : 'a. ('a -> 'a -> bool) -> 'a ref -> 'a ref -> bool
val globalize_ref : 'a. ('a -> 'a) -> 'a ref -> 'a ref
val ref_of_sexp : 'a. (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a ref
val sexp_of_ref : 'a. ('a -> Sexplib0.Sexp.t) -> 'a ref -> Sexplib0.Sexp.t
val ref_sexp_grammar : 'a. 'a Sexplib0.Sexp_grammar.t -> 'a ref Sexplib0.Sexp_grammar.t
type string = Base.String.t
val compare_string__local : string -> string -> int
val compare_string : string -> string -> int
val equal_string__local : string -> string -> bool
val equal_string : string -> string -> bool
val globalize_string : string -> string
val hash_fold_string : Base.Hash.state -> string -> Base.Hash.state
val hash_string : string -> Base.Hash.hash_value
val string_of_sexp : Sexplib0.Sexp.t -> string
val sexp_of_string : string -> Sexplib0.Sexp.t
val string_sexp_grammar : string Sexplib0.Sexp_grammar.t
type bytes = Bytes.t
val compare_bytes__local : bytes -> bytes -> int
val compare_bytes : bytes -> bytes -> int
val equal_bytes__local : bytes -> bytes -> bool
val equal_bytes : bytes -> bytes -> bool
val globalize_bytes : bytes -> bytes
val bytes_of_sexp : Sexplib0.Sexp.t -> bytes
val sexp_of_bytes : bytes -> Sexplib0.Sexp.t
val bytes_sexp_grammar : bytes Sexplib0.Sexp_grammar.t
type unit = Unit.t
val compare_unit__local : unit -> unit -> int
val compare_unit : unit -> unit -> int
val equal_unit__local : unit -> unit -> bool
val equal_unit : unit -> unit -> bool
val globalize_unit : unit -> unit
val hash_fold_unit : Base.Hash.state -> unit -> Base.Hash.state
val hash_unit : unit -> Base.Hash.hash_value
val unit_of_sexp : Sexplib0.Sexp.t -> unit
val sexp_of_unit : unit -> Sexplib0.Sexp.t
val unit_sexp_grammar : unit Sexplib0.Sexp_grammar.t

Format stuff

type nonrec ('a, 'b, 'c) format = ('a, 'b, 'c) format
type nonrec ('a, 'b, 'c, 'd) format4 = ('a, 'b, 'c, 'd) format4
type 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
val (@) : '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
val (~-) : Base.Int.t -> Base.Int.t
val (land) : Base.Int.t -> Base.Int.t -> Base.Int.t
val (lor) : Base.Int.t -> Base.Int.t -> Base.Int.t
val (lxor) : Base.Int.t -> Base.Int.t -> Base.Int.t
val lnot : Base.Int.t -> Base.Int.t
val abs : Base.Int.t -> Base.Int.t
val neg : Base.Int.t -> Base.Int.t
val zero : Base.Int.t
val (//) : Base.Int.t -> Base.Int.t -> float
val (lsl) : Base.Int.t -> int -> Base.Int.t
val (asr) : Base.Int.t -> int -> Base.Int.t
val (lsr) : Base.Int.t -> int -> Base.Int.t
val (=) : int -> int -> bool
val (<>) : int -> int -> bool
val (<) : int -> int -> bool
val (>) : int -> int -> bool
val (<=) : int -> int -> bool
val (>=) : int -> int -> bool
val compare : int -> int -> int
val compare__local : int -> int -> int
val equal : int -> int -> bool
val equal__local : int -> int -> bool
val ascending : int -> int -> int
val descending : int -> int -> int
val max : int -> int -> int
val min : int -> int -> int

Float operators

include module type of struct include Float.O_dot end

Similar to O, except that operators are suffixed with a dot, allowing one to have both int and float operators in scope simultaneously.

Similar to O, except that operators are suffixed with a dot, allowing one to have both int and float operators in scope simultaneously.

val (~-.) : Base.Float.t -> Base.Float.t
val (|>) : 'a -> ('a -> 'b) -> 'b

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

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

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

Boolean operations

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

Common string operations

Reference operations

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

Pair operations

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

Exceptions stuff

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

Misc

val phys_equal : 'a -> 'a -> bool
val force : 'a Lazy.t -> '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