package base

  1. Overview
  2. Docs
package base
Legend:
Library
Module
Module type
Parameter
Class
Class type
include module type of struct include Shadow_stdlib end with module Array := Caml.Array with module Buffer := Caml.Buffer with module Char := Caml.Char with module Hashtbl := Caml.Hashtbl with module Int32 := Caml.Int32 with module Int64 := Caml.Int64 with module Lazy := Caml.Lazy with module List := Caml.List with module Map := Caml.Map with module Nativeint := Caml.Nativeint with module Printf := Caml.Printf with module Random := Caml.Random with module Set := Caml.Set with module String := Caml.String with module Sys := Caml.Sys with module Uchar := Caml.Uchar with module Lexing := Caml.Lexing with type ('a, 'b, 'c) format := ('a, 'b, 'c) Pervasives.format with type ('a, 'b, 'c, 'd) format4 := ('a, 'b, 'c, 'd) Pervasives.format4 with type ('a, 'b, 'c, 'd, 'e, 'f) format6 := ('a, 'b, 'c, 'd, 'e, 'f) Pervasives.format6 with type 'a ref := 'a Pervasives.ref
module Arg = Shadow_stdlib.Arg
module ArrayLabels = Shadow_stdlib.ArrayLabels
module Bytes = Shadow_stdlib.Bytes
module BytesLabels = Shadow_stdlib.BytesLabels
module Callback = Shadow_stdlib.Callback
module Complex = Shadow_stdlib.Complex
module Digest = Shadow_stdlib.Digest
module Ephemeron = Shadow_stdlib.Ephemeron
module Filename = Shadow_stdlib.Filename
module Format = Shadow_stdlib.Format
module Gc = Shadow_stdlib.Gc
module Genlex = Shadow_stdlib.Genlex
module ListLabels = Shadow_stdlib.ListLabels
module Marshal = Shadow_stdlib.Marshal
module MoreLabels = Shadow_stdlib.MoreLabels
module Obj = Shadow_stdlib.Obj
module Oo = Shadow_stdlib.Oo
module Parsing = Shadow_stdlib.Parsing
module Pervasives = Shadow_stdlib.Pervasives
module Printexc = Shadow_stdlib.Printexc
module Queue = Shadow_stdlib.Queue
module Scanf = Shadow_stdlib.Scanf
module Sort = Shadow_stdlib.Sort
module Spacetime = Shadow_stdlib.Spacetime
module Stack = Shadow_stdlib.Stack
module StdLabels = Shadow_stdlib.StdLabels
module Stream = Shadow_stdlib.Stream
module StringLabels = Shadow_stdlib.StringLabels
module Weak = Shadow_stdlib.Weak
val raise_notrace : exn -> 'a
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.raise_notrace] instead
exception Exit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Refering to the stdlib directly is discouraged by Base. You should either use the equivalent functionality offered by Base, or if you really want to refer to the stdlib, use Caml.Exit instead
val (==) : 'a -> 'a -> bool
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [phys_equal] instead.
val (!=) : 'a -> 'a -> bool
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [not (phys_equal ...)] instead.
val (&) : bool -> bool -> bool
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.( & )] instead
val or : bool -> bool -> bool
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.( or )] instead
val __LOC__ : string
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.__LOC__] instead
val __FILE__ : string
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.__FILE__] instead
val __LINE__ : int
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.__LINE__] instead
val __MODULE__ : string
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.__MODULE__] instead
val __POS__ : string * int * int * int
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.__POS__] instead
val __LOC_OF__ : 'a -> string * 'a
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.__LOC_OF__] instead
val __LINE_OF__ : 'a -> int * 'a
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.__LINE_OF__] instead
val __POS_OF__ : 'a -> (string * int * int * int) * 'a
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.__POS_OF__] instead
val (@@) : ('a -> 'b) -> 'a -> 'b
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.( @@ )] instead
val (~+) : int -> int
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.( ~+ )] instead
val succ : int -> int
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.succ] instead
val pred : int -> int
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.pred] instead
val (mod) : int -> int -> int
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.( mod )] instead
val max_int : int
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.max_int] instead
val min_int : int
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.min_int] instead
val (~-.) : float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.( ~-. )] instead
val (~+.) : float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.( ~+. )] instead
val (+.) : float -> float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.( +. )] instead
val (-.) : float -> float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.( -. )] instead
val (*.) : float -> float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.( *. )] instead
val (/.) : float -> float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.( /. )] instead
val (**) : float -> float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.( ** )] instead
val sqrt : float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.sqrt] instead
val exp : float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.exp] instead
val log : float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.log] instead
val log10 : float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.log10] instead
val expm1 : float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.expm1] instead
val log1p : float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.log1p] instead
val cos : float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.cos] instead
val sin : float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.sin] instead
val tan : float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.tan] instead
val acos : float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.acos] instead
val asin : float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.asin] instead
val atan : float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.atan] instead
val atan2 : float -> float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.atan2] instead
val hypot : float -> float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.hypot] instead
val cosh : float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.cosh] instead
val sinh : float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.sinh] instead
val tanh : float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.tanh] instead
val ceil : float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.ceil] instead
val floor : float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.floor] instead
val abs_float : float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.abs_float] instead
val copysign : float -> float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.copysign] instead
val mod_float : float -> float -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.mod_float] instead
val frexp : float -> float * int
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.frexp] instead
val ldexp : float -> int -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.ldexp] instead
val modf : float -> float * float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.modf] instead
val float : int -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.float] instead
val float_of_int : int -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.float_of_int] instead
val truncate : float -> int
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.truncate] instead
val int_of_float : float -> int
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.int_of_float] instead
val infinity : float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.infinity] instead
val neg_infinity : float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.neg_infinity] instead
val nan : float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.nan] instead
val max_float : float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.max_float] instead
val min_float : float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.min_float] instead
val epsilon_float : float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.epsilon_float] instead
type nonrec fpclass = Pervasives.fpclass =
  1. | FP_normal
  2. | FP_subnormal
  3. | FP_zero
  4. | FP_infinite
  5. | FP_nan
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Refering to the stdlib directly is discouraged by Base. You should either use the equivalent functionality offered by Base, or if you really want to refer to the stdlib, use Caml.fpclass instead
val classify_float : float -> fpclass
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.classify_float] instead
val int_of_char : char -> int
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.int_of_char] instead
val char_of_int : int -> char
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.char_of_int] instead
val string_of_bool : bool -> string
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.string_of_bool] instead
val bool_of_string : string -> bool
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.bool_of_string] instead
val bool_of_string_opt : string -> bool option
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.bool_of_string_opt] instead
val string_of_int : int -> string
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.string_of_int] instead
val int_of_string : string -> int
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.int_of_string] instead
val int_of_string_opt : string -> int option
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.int_of_string_opt] instead
val string_of_float : float -> string
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.string_of_float] instead
val float_of_string : string -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.float_of_string] instead
val float_of_string_opt : string -> float option
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.float_of_string_opt] instead
type nonrec in_channel = Pervasives.in_channel
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.In_channel.t] instead.
type nonrec out_channel = Pervasives.out_channel
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.Out_channel.t] instead.
val stdin : in_channel
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.stdin] instead.
val stdout : out_channel
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.stdout] instead.
val stderr : out_channel
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.stderr] instead.
val print_char : char -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.Out_channel.output_char Stdio.stdout] instead.
val print_string : string -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.Out_channel.output_string Stdio.stdout] instead.
val print_bytes : bytes -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.print_bytes] instead
val print_int : int -> unit
  • deprecated
val print_float : float -> unit
  • deprecated
val print_endline : string -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.print_endline] instead.
val print_newline : unit -> unit
  • deprecated
val prerr_char : char -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.Out_channel.output_char Stdio.stderr] instead.
val prerr_string : string -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.Out_channel.output_string Stdio.stderr] instead.
val prerr_bytes : bytes -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.prerr_bytes] instead
val prerr_int : int -> unit
  • deprecated
val prerr_float : float -> unit
  • deprecated
val prerr_endline : string -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.prerr_endline] instead.
val prerr_newline : unit -> unit
  • deprecated
val read_line : unit -> string
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.In_channel.input_line] instead.
val read_int : unit -> int
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.read_int] instead
val read_int_opt : unit -> int option
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.read_int_opt] instead
val read_float : unit -> float
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.read_float] instead
val read_float_opt : unit -> float option
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.read_float_opt] instead
type nonrec open_flag = Pervasives.open_flag =
  1. | Open_rdonly
  2. | Open_wronly
  3. | Open_append
  4. | Open_creat
  5. | Open_trunc
  6. | Open_excl
  7. | Open_binary
  8. | Open_text
  9. | Open_nonblock
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Refering to the stdlib directly is discouraged by Base. You should either use the equivalent functionality offered by Base, or if you really want to refer to the stdlib, use Caml.open_flag instead
val open_out : string -> out_channel
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.Out_channel.create] instead.
val open_out_bin : string -> out_channel
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.Out_channel.create] instead.
val open_out_gen : open_flag list -> int -> string -> out_channel
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.open_out_gen] instead
val flush : out_channel -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.Out_channel.flush] instead.
val flush_all : unit -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.flush_all] instead
val output_char : out_channel -> char -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.Out_channel.output_char] instead.
val output_string : out_channel -> string -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.Out_channel.output_string] instead.
val output_bytes : out_channel -> bytes -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.output_bytes] instead
val output : out_channel -> bytes -> int -> int -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.Out_channel.output] instead.
val output_substring : out_channel -> string -> int -> int -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.Out_channel.output] instead.
val output_byte : out_channel -> int -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.Out_channel.output_byte] instead.
val output_binary_int : out_channel -> int -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.Out_channel.output_binary_int] instead.
val output_value : out_channel -> 'a -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.Out_channel.output_value] instead.
val seek_out : out_channel -> int -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.Out_channel.seek] instead.
val pos_out : out_channel -> int
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.Out_channel.pos] instead.
val out_channel_length : out_channel -> int
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.Out_channel.length] instead.
val close_out : out_channel -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.Out_channel.close] instead.
val close_out_noerr : out_channel -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.Out_channel.close] instead.
val set_binary_mode_out : out_channel -> bool -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.Out_channel.set_binary_mode] instead.
val open_in : string -> in_channel
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.In_channel.create] instead.
val open_in_bin : string -> in_channel
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.In_channel.create] instead.
val open_in_gen : open_flag list -> int -> string -> in_channel
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.open_in_gen] instead
val input_char : in_channel -> char
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.In_channel.input_char] instead.
val input_line : in_channel -> string
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.In_channel.input_line] instead.
val input : in_channel -> bytes -> int -> int -> int
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.In_channel.input] instead.
val really_input : in_channel -> bytes -> int -> int -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.In_channel.really_input] instead.
val really_input_string : in_channel -> int -> string
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is no equivalent functionality in Base or Stdio but you can use [Stdio.Out_channel] instead. Alternatively, if you really want to refer the stdlib function you can use [Caml.really_input_string].
val input_byte : in_channel -> int
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.In_channel.input_byte] instead.
val input_binary_int : in_channel -> int
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.In_channel.input_binary_int] instead.
val input_value : in_channel -> 'a
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.In_channel.unsafe_input_value] instead.
val seek_in : in_channel -> int -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.In_channel.seek] instead.
val pos_in : in_channel -> int
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.In_channel.pos] instead.
val in_channel_length : in_channel -> int
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.In_channel.length] instead.
val close_in : in_channel -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.In_channel.close] instead.
val close_in_noerr : in_channel -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.In_channel.close] instead.
val set_binary_mode_in : in_channel -> bool -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Use [Stdio.In_channel.set_binary_mode] instead.
module LargeFile = Shadow_stdlib.LargeFile
val incr : int Pervasives.ref -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.incr] instead
val decr : int Pervasives.ref -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.decr] instead
type nonrec ('a, 'b) result = ('a, 'b) Pervasives.result =
  1. | Ok of 'a
  2. | Error of 'b
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. Refering to the stdlib directly is discouraged by Base. You should either use the equivalent functionality offered by Base, or if you really want to refer to the stdlib, use Caml.result instead
val string_of_format : ('a, 'b, 'c, 'd, 'e, 'f) Pervasives.format6 -> string
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.string_of_format] instead
val format_of_string : ('a, 'b, 'c, 'd, 'e, 'f) Pervasives.format6 -> ('a, 'b, 'c, 'd, 'e, 'f) Pervasives.format6
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.format_of_string] instead
val (^^) : ('a, 'b, 'c, 'd, 'e, 'f) Pervasives.format6 -> ('f, 'b, 'c, 'e, 'g, 'h) Pervasives.format6 -> ('a, 'b, 'c, 'd, 'g, 'h) Pervasives.format6
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.( ^^ )] instead
val exit : int -> 'a
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.exit] instead
val at_exit : (unit -> unit) -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.at_exit] instead
val valid_float_lexem : string -> string
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.valid_float_lexem] instead
val unsafe_really_input : in_channel -> bytes -> int -> int -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.unsafe_really_input] instead
val do_at_exit : unit -> unit
  • deprecated [2016-09] this element comes from the stdlib distributed with OCaml. There is not equivalent functionality in Base or Stdio at the moment, so you need to use [Caml.do_at_exit] instead
module Applicative : sig ... end
module Applicative_intf : sig ... end

Applicatives model computations in which values computed by subcomputations cannot affect what subsequent computations will take place. Relative to monads, this restriction takes power away from the user of the interface and gives it to the implementation. In particular, because the structure of the entire computation is known, one can augment its definition with some description of that structure.

module Array : sig ... end
module Avltree : sig ... end

A low-level, mutable AVL tree.

module Backtrace : sig ... end

Dealing with stack backtraces.

General functions for performing binary searches over ordered sequences given length and get functions. These functions can be specialized and added to a data structure using the functors supplied in Binary_searchable and described in Binary_searchable_intf.

module Binary_searchable : sig ... end

See Binary_searchable_intf.

module Binary_searchable_intf : sig ... end

Module types for a binary_search function for a sequence, and functors for building binary_search functions.

module Blit : sig ... end

See Blit_intf for documentation.

module Blit_intf : sig ... end

Standard type for blit functions, and reusable code for validating blit arguments.

module Bool : sig ... end
module Buffer : sig ... end
module Char : sig ... end

Character operations.

module Commutative_group : sig ... end

A signature for a commutative group (in the group-theory sense).

module Comparable : sig ... end
module Comparable_intf : sig ... end
module Comparator : sig ... end

A type-indexed value that allows one to compare (and for generating error messages, serialize) values of the type in question.

module Container : sig ... end
module Container_intf : sig ... end

This file has generic signatures for container data structures, with standard functions (iter, fold, exists, for_all, ...) that one would expect to find in any container. The idea is to include Container.S0 or Container.S1 in the signature for every container-like data structure (Array, List, String, ...) to ensure a consistent interface.

module Either : sig ... end
module Either_intf : sig ... end

Many functions in Either focus on just one constructor. The Focused signature abstracts over which constructor is the focus. To use these functions, use the First or Second modules in S.

module Equal : sig ... end

This module defines signatures that are to be included in other signatures to ensure a consistent interface to equal functions. There is a signature (S, S1, S2, S3) for each arity of type. Usage looks like:

module Error : sig ... end

A lazy string, implemented with Info, but intended specifically for error messages.

module Exn : sig ... end

sexp_of_t uses a global table of sexp converters. To register a converter for a new exception, add [@@deriving_inline sexp][@@@end] to its definition. If no suitable converter is found, the standard converter in Printexc will be used to generate an atomic S-expression.

module Field : sig ... end

OCaml record field.

module Float : sig ... end

Floating-point representation and utilities.

module Floatable : sig ... end
module Fn : sig ... end

various combinators for functions

module Hash : sig ... end
module Hash_intf : sig ... end

Hash_intf.S is the interface which a hash-function must support

module Hash_set : sig ... end
module Hash_set_intf : sig ... end
module Hasher : sig ... end

Signatures required of types which can be used in [@@deriving_inline hash][@@@end].

module Hashtbl : sig ... end
module Hashtbl_intf : sig ... end
module Heap_block : sig ... end

A heap block is a value that is guaranteed to live on the OCaml heap, and is hence guaranteed to be usable with finalization or in a weak pointer. It is an abstract type so we can use the type system to guarantee that the values we put in weak pointers and use with finalizers are heap blocks.

module Identifiable : sig ... end

A signature combining functionality that is commonly used for types that are intended to act as names or identifiers.

module Indexed_container : sig ... end
module Info : sig ... end
module Info_intf : sig ... end

Info is a library for lazily constructing human-readable information as a string or sexp, with a primary use being error messages. Using Info is often preferable to sprintf or manually constructing strings because you don't have to eagerly construct the string --- you only need to pay when you actually want to display the info. which for many applications is rare. Using Info is also better than creating custom exceptions because you have more control over the format.

module Int : sig ... end

OCaml's native integer type.

module Int32 : sig ... end

An int of exactly 32 bits, regardless of the machine.

module Int63 : sig ... end

63-bit integers.

module Int64 : sig ... end
module Int_intf : sig ... end
module Intable : sig ... end
module Invariant : sig ... end
module Lazy : sig ... end

This file is a modified version of lazy.mli from the OCaml distribution.

module List : sig ... end

List operations.

module Map : sig ... end
module Map_intf : sig ... end

See map.mli for comments.

module Maybe_bound : sig ... end
module Monad : sig ... end
module Nativeint : sig ... end
module Option : sig ... end
module Or_error : sig ... end

Type for tracking errors in an Error.t. This is a specialization of the Result type, where the Error constructor carries an Error.t.

module Ordered_collection_common : sig ... end
module Ordering : sig ... end

Ordering is intended to make code that matches on the result of a comparison more concise and easier to read. For example, one would write:

module Poly : sig ... end
module Polymorphic_compare : sig ... end
module Polymorphic_compare_intf : sig ... end

Interfaces used for hiding and replacing polymorphic compare. Including a module with interface S should hide the majority of functions that use polymorphic compare.

module Popcount : sig ... end

This module exposes popcount functions for the various integer types. Functions are exposed in their respective modules.

module Pretty_printer : sig ... end

A list of pretty printers for various types, for use in toplevels.

module Printf : sig ... end
module Linked_queue : sig ... end

This module is a wrapper around OCaml's standard Queue module that follows Base idioms and adds some functions. See Queue_intf for documentation of standard queue functions.

module Queue_intf : sig ... end

An interface for queues that follows Base's conventions, as opposed to OCaml's standard Queue module.

module Random : sig ... end

This is a slightly modified version of the OCaml standard library's random.mli. We want Base's Random module to be different from OCaml's standard one:

module Ref : sig ... end

Module for the type ref

module Result : sig ... end

Result is often used to handle error messages.

module Sequence : sig ... end

A sequence of elements that can be produced one at a time, on demand, normally with no sharing.

module Set : sig ... end
module Set_intf : sig ... end

See set.mli for comments.

module Sexpable : sig ... end

New code should use the @@deriving_inline sexp@@@end syntax directly. These module types (S, S1, S2, and S3) are exported for backwards compatibility only. *

module Sign : sig ... end

A simple type for representing the sign of a numeric value.

module Source_code_position : sig ... end

One typically obtains a Source_code_position.t using a [%here] expression, which is implemented by the ppx_here preprocessor.

module Staged : sig ... end

A type for making staging explicit in the type of a function. For example, you might want to have a function that creates a function for allocating unique identifiers. Rather than using the type:

module String : sig ... end

An extension of the standard StringLabels. If you open Base, you'll get these in the String module.

module Stringable : sig ... end
module String_dict : sig ... end

Efficient static string dictionaries. By static, we mean that new key-value pairs cannot be added after the dictionary is created.

module Sys : sig ... end

Cross-platform system configuration values.

module T : sig ... end
module Type_equal : sig ... end

For representing type equalities otherwise not known by the type-checker.

module Unit : sig ... end

Module for the type unit

module Uchar : sig ... end

Unicode character operations.

module Validate : sig ... end

A module for organizing validations of data structures. Allows standardized ways of checking for conditions, and keeps track of the location of errors by keeping a path to each error found. Thus, if you were validating the following datastructure:

module Variant : sig ... end

OCaml variant type.

module With_return : sig ... end

with_return f allows for something like the return statement in C within f. There are three ways f can terminate:

module Word_size : sig ... end

For determining the word size that the program is using.

module Sexp : sig ... end
module Export : sig ... end
include module type of struct include Export end
type 'a array = 'a Array.t
val array_of_sexp : 'a. (Sexp.t -> 'a) -> Sexp.t -> 'a array
val sexp_of_array : 'a. ('a -> Sexp.t) -> 'a array -> Sexp.t
val compare_array : 'a. ('a -> 'a -> int) -> 'a array -> 'a array -> int
type bool = Bool.t
val bool_of_sexp : Sexp.t -> bool
val sexp_of_bool : bool -> Sexp.t
val hash_fold_bool : Hash.state -> bool -> Hash.state
val hash_bool : bool -> Hash.hash_value
val compare_bool : bool -> bool -> int
type char = Char.t
val char_of_sexp : Sexp.t -> char
val sexp_of_char : char -> Sexp.t
val hash_fold_char : Hash.state -> char -> Hash.state
val hash_char : char -> Hash.hash_value
val compare_char : char -> char -> int
type exn = Exn.t
val sexp_of_exn : exn -> Sexp.t
type float = Float.t
val float_of_sexp : Sexp.t -> float
val sexp_of_float : float -> Sexp.t
val hash_fold_float : Hash.state -> float -> Hash.state
val hash_float : float -> Hash.hash_value
val compare_float : float -> float -> int
type int = Int.t
val int_of_sexp : Sexp.t -> int
val sexp_of_int : int -> Sexp.t
val hash_fold_int : Hash.state -> int -> Hash.state
val hash_int : int -> Hash.hash_value
val compare_int : int -> int -> int
type int32 = Int32.t
val int32_of_sexp : Sexp.t -> int32
val sexp_of_int32 : int32 -> Sexp.t
val hash_fold_int32 : Hash.state -> int32 -> Hash.state
val hash_int32 : int32 -> Hash.hash_value
val compare_int32 : int32 -> int32 -> int
type int64 = Int64.t
val int64_of_sexp : Sexp.t -> int64
val sexp_of_int64 : int64 -> Sexp.t
val hash_fold_int64 : Hash.state -> int64 -> Hash.state
val hash_int64 : int64 -> Hash.hash_value
val compare_int64 : int64 -> int64 -> int
type 'a list = 'a List.t
val list_of_sexp : 'a. (Sexp.t -> 'a) -> Sexp.t -> 'a list
val sexp_of_list : 'a. ('a -> Sexp.t) -> 'a list -> Sexp.t
val hash_fold_list : 'a. (Hash.state -> 'a -> Hash.state) -> Hash.state -> 'a list -> Hash.state
val compare_list : 'a. ('a -> 'a -> int) -> 'a list -> 'a list -> int
type nativeint = Nativeint.t
val nativeint_of_sexp : Sexp.t -> nativeint
val sexp_of_nativeint : nativeint -> Sexp.t
val hash_fold_nativeint : Hash.state -> nativeint -> Hash.state
val hash_nativeint : nativeint -> Hash.hash_value
val compare_nativeint : nativeint -> nativeint -> int
type 'a option = 'a Option.t
val option_of_sexp : 'a. (Sexp.t -> 'a) -> Sexp.t -> 'a option
val sexp_of_option : 'a. ('a -> Sexp.t) -> 'a option -> Sexp.t
val hash_fold_option : 'a. (Hash.state -> 'a -> Hash.state) -> Hash.state -> 'a option -> Hash.state
val compare_option : 'a. ('a -> 'a -> int) -> 'a option -> 'a option -> int
type 'a ref = 'a Ref.t
val ref_of_sexp : 'a. (Sexp.t -> 'a) -> Sexp.t -> 'a ref
val sexp_of_ref : 'a. ('a -> Sexp.t) -> 'a ref -> Sexp.t
val compare_ref : 'a. ('a -> 'a -> int) -> 'a ref -> 'a ref -> int
type string = String.t
val string_of_sexp : Sexp.t -> string
val sexp_of_string : string -> Sexp.t
val hash_fold_string : Hash.state -> string -> Hash.state
val hash_string : string -> Hash.hash_value
val compare_string : string -> string -> int
type unit = Unit.t
val unit_of_sexp : Sexp.t -> unit
val sexp_of_unit : unit -> Sexp.t
val hash_fold_unit : Hash.state -> unit -> Hash.state
val hash_unit : unit -> Hash.hash_value
val compare_unit : unit -> unit -> int
type nonrec ('a, 'b, 'c) format = ('a, 'b, 'c) Pervasives.format

Format stuff

type nonrec ('a, 'b, 'c, 'd) format4 = ('a, 'b, 'c, 'd) Pervasives.format4
type nonrec ('a, 'b, 'c, 'd, 'e, 'f) format6 = ('a, 'b, 'c, 'd, 'e, 'f) Pervasives.format6

List operators

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

Int operators and comparisons

include module type of struct include Int.O end

A sub-module designed to be opened to make working with ints more convenient.

A sub-module designed to be opened to make working with ints more convenient.

include Int_intf.Operators_unbounded with type t := Int.t
val (+) : Int.t -> Int.t -> Int.t
val (-) : Int.t -> Int.t -> Int.t
val (*) : Int.t -> Int.t -> Int.t
val (/) : Int.t -> Int.t -> Int.t
val (~-) : Int.t -> Int.t
include Polymorphic_compare_intf.Infix with type t := Int.t
val abs : Int.t -> Int.t
val neg : Int.t -> Int.t
val zero : Int.t
val of_int_exn : int -> Int.t
val (%) : Int.t -> Int.t -> Int.t
val (/%) : Int.t -> Int.t -> Int.t
val (//) : Int.t -> Int.t -> float
val (land) : Int.t -> Int.t -> Int.t
val (lor) : Int.t -> Int.t -> Int.t
val (lxor) : Int.t -> Int.t -> Int.t
val lnot : Int.t -> Int.t
val (lsl) : Int.t -> int -> Int.t
val (asr) : Int.t -> int -> Int.t
val (lsr) : Int.t -> int -> 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 ascending : int -> int -> int
val descending : int -> int -> int
val compare : int -> int -> int
val equal : int -> int -> bool
val max : int -> int -> int
val min : int -> int -> int
val (|>) : 'a -> ('a -> 'b) -> 'b

Composition operator

val (&&) : bool -> bool -> bool

Boolean operations

val (||) : bool -> bool -> bool
val not : bool -> bool
val ignore : _ -> unit
val (^) : String.t -> String.t -> String.t

Common string operations

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

Reference operations

val ref : 'a -> 'a ref
val (:=) : 'a ref -> 'a -> unit
val fst : ('a * 'b) -> 'a

Pair operations

val snd : ('a * 'b) -> 'b
val failwith : string -> 'a

Exceptions stuff

val invalid_arg : string -> 'a
val raise : exn -> 'a
val raise_s : Sexp.t -> 'a
val phys_equal : 'a -> 'a -> bool

Misc

module Not_exposed_properly : sig ... end
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