package core

  1. Overview
  2. Docs
package core
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file core.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
(** Core greatly expands the functionality available in Base while still remaining
    platform-agnostic.  Core changes more frequently (i.e., is less stable) than Base.

    Some modules are mere extensions of their counterparts in Base, usually adding generic
    functionality by including functors that make them binable, comparable, sexpable,
    blitable, etc.  The bulk of Core, though, is modules providing entirely new
    functionality. *)

open! Import


module Applicative = Applicative
module Arg = Arg
module Array = Array
module Avltree = Avltree
module Backtrace = Backtrace
module Bag = Bag
module Bigbuffer = Bigbuffer
module Bigstring = Bigstring
module Bigsubstring = Bigsubstring
module Bin_prot = Core_bin_prot
module Binable = Binable
module Binary_search = Binary_search
module Binary_searchable = Binary_searchable
module Blang = Blang
module Blit = Blit
module Bool = Bool
module Bounded_index = Bounded_index
module Buffer = Base.Buffer
module Byte_units = Byte_units
module Bytes = Bytes

module Caml = struct
  include Caml

  (* When we removed [Core.Caml]'s extensions of [Core.Caml], we added
     the declarations below to force code to switch to the new names, and avoid
     silently incorrectly using something else in scope. *)
  module Condition = struct end
  [@@deprecated "[since 2021-02] Use [Caml_threads.Condition]"]

  module Mutex = struct end [@@deprecated "[since 2021-02] Use [Caml_threads.Mutex]"]
  module Thread = struct end [@@deprecated "[since 2021-02] Use [Caml_threads.Thread]"]
  module Unix = struct end [@@deprecated "[since 2021-02] Use [Caml_unix]"]
  module UnixLabels = struct end [@@deprecated "[since 2021-02] Use [UnixLabels]"]
end

module Char = Char
module Command = Command
module Comparable = Comparable
module Comparator = Comparator
module Comparisons = Comparisons
module Container = Container
module Container_intf = Container_intf
module Continue_or_stop = Continue_or_stop

module Core_kernel_stable = Stable
[@@deprecated "[since 2021-05] Use [Core_stable] -- [Core_kernel] was renamed as [Core]"]

module Core_stable = Stable
module Date = Date
module Day_of_week = Day_of_week
module Debug = Debug
module Deque = Deque
module Deriving_hash = Deriving_hash
module Digest = Md5 [@@ocaml.deprecated "[since 2017-05] Use Md5 instead."]
module Doubly_linked = Doubly_linked
module Either = Either
module Ephemeron = Ephemeron
module Equal = Equal
module Error = Error
module Exn = Base.Exn
module Expect_test_config = Expect_test_config
module Fdeque = Fdeque
module Field = Field
module Filename = Filename
module Float = Float
module Float_with_finite_only_serialization = Float_with_finite_only_serialization
module Floatable = Floatable
module Fn = Fn
module Formatter = Formatter
module Fqueue = Fqueue
module Gc = Gc
module Hash = Hash
module Hash_queue = Hash_queue
module Hash_set = Hash_set
module Hashable = Hashable
module Hashtbl = Hashtbl
module Hashtbl_intf = Hashtbl_intf
module Heap_block = Heap_block
module Hexdump = Hexdump
module Hexdump_intf = Hexdump_intf
module Host_and_port = Host_and_port
module Identifiable = Identifiable
module Immediate_option = Immediate_option
module Immediate_option_intf = Immediate_option_intf
module In_channel = In_channel
module Indexed_container = Indexed_container
module Info = Info
module Int = Int
module Int32 = Int32
module Int63 = Int63
module Int64 = Int64
module Int_conversions = Int_conversions
module Int_intf = Int_intf
module Int_math = Int_math
module Intable = Intable
module Interfaces = Interfaces
module Invariant = Invariant
module Lazy = Lazy
module Linked_queue = Linked_queue
module List = List
module Map = Map
module Map_intf = Map_intf
module Maybe_bound = Maybe_bound
module Md5 = Md5
module Memo = Memo
module Monad = Monad
module Month = Month

module Mutex = struct end
[@@deprecated "[since 2019-02] Use [Error_checking_mutex] or [Caml_threads.Mutex]"]

module Nativeint = Nativeint
module No_polymorphic_compare = No_polymorphic_compare
module Nothing = Nothing
module Only_in_test = Only_in_test
module Option = Option
module Option_array = Option_array
module Optional_syntax = Optional_syntax
module Optional_syntax_intf = Optional_syntax_intf
module Or_error = Or_error
module Ordered_collection_common = Ordered_collection_common
module Ordering = Ordering
module Out_channel = Out_channel
module Percent = Percent
module Perms = Perms
module Pid = Pid
module Poly = Poly
module Polymorphic_compare = Poly [@@deprecated "[since 2018-11] use [Poly] instead"]

module Popcount = Base.Popcount
[@@warning "-3"]
[@@deprecated "[since 2018-10] use [popcount] functions in individual int modules"]

module Pretty_printer = Pretty_printer
module Printexc = Printexc
module Printf = Printf
module Queue = Queue
module Quickcheck = Quickcheck
module Quickcheck_intf = Quickcheck_intf
module Quickcheckable = Quickcheckable
module Random = Base.Random
module Ref = Ref
module Result = Result
module Robustly_comparable = Robustly_comparable
module Sequence = Sequence
module Set = Set
module Set_intf = Set_intf
module Set_once = Set_once
module Sexp_maybe = Sexp.Sexp_maybe

module Sexp = Sexp
module Sexpable = Sexpable
module Sign = Sign
module Signal = Signal
module Sign_or_nan = Sign_or_nan
module Source_code_position = Source_code_position
module Splittable_random = Splittable_random
module Stable_comparable = Stable_comparable
module Stable_unit_test = Stable_unit_test
module Stack = Stack
module Staged = Base.Staged
module String = String
module String_id = String_id
module Stringable = Stringable
module Substring = Substring
module Substring_intf = Substring_intf
module Sys = Core_sys

module Thread = struct end
[@@deprecated "[since 2021-04] Use [Core_thread] or [Caml_threads.Thread]"]

module Time = Time_float
module Time_ns = Time_ns
module Tuple = Tuple
module Tuple2 = Tuple.T2
module Tuple3 = Tuple.T3
module Type_equal = Type_equal
module Type_immediacy = Type_immediacy
module Uchar = Uchar
module Uniform_array = Uniform_array
module Union_find = Union_find
module Unique_id = Unique_id
module Unit = Unit
module Unit_of_time = Unit_of_time
module Univ_map = Univ_map

module Unix = struct end
[@@deprecated
  "[since 2020-03] Core shadows Unix. Use Core_unix, which overrides some of Unix's \
   behavior. If necessary, Unix is available and unshadowed as Caml_unix."]

module Validate = Validate
module Validated = Validated
module Variant = Variant
module Weak = Weak
module With_return = With_return
module Word_size = Word_size

module type Unique_id = Unique_id.Id

include T (** @open *)

include Std_internal
include Not_found

(** {2 Top-level values} *)

type 'a _maybe_bound = 'a Maybe_bound.t =
  | Incl of 'a
  | Excl of 'a
  | Unbounded

let am_running_inline_test = am_running_inline_test
let am_running_test = am_running_test
let does_raise = Exn.does_raise
let sec = Time_float.Span.of_sec
let ( ^/ ) = Filename.concat

(** We perform these side effects here because we want them to run for any code that uses
    [Core].  If this were in another module in [Core] that was not used in some program,
    then the side effects might not be run in that program.  This will run as long as the
    program refers to at least one value directly in Core; referring to values in
    [Core.Bool], for example, is not sufficient. *)
let () = Exn.initialize_module ()

(** To be used in implementing Core, but not by end users. *)
module Core_private = struct
  module Digit_string_helpers = Digit_string_helpers
  module Time_zone = Zone
  module Ofday_helpers = Ofday_helpers
  module Span_float = Span_float

  module Bigbuffer_internal = Bigbuffer_internal
  module Stable_internal = Stable_internal
  module Std_internal = Std_internal

  module Time_ns_alternate_sexp = Time_ns_alternate_sexp
end

module Core_kernel_private = Core_private
[@@deprecated "[since 2021-05] Use [Core_private] -- [Core_kernel] was renamed as [Core]"]
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