1Stdlib.Obj(3)                    OCaml library                   Stdlib.Obj(3)
2
3
4

NAME

6       Stdlib.Obj - no description
7

Module

9       Module   Stdlib.Obj
10

Documentation

12       Module Obj
13        : (module Stdlib__Obj)
14
15
16
17
18
19
20
21       type t
22
23
24
25
26       type raw_data = nativeint
27
28
29
30
31
32       val repr : 'a -> t
33
34
35
36
37       val obj : t -> 'a
38
39
40
41
42       val magic : 'a -> 'b
43
44
45
46
47       val is_block : t -> bool
48
49
50
51
52       val is_int : t -> bool
53
54
55
56
57       val tag : t -> int
58
59
60
61
62       val size : t -> int
63
64
65
66
67       val reachable_words : t -> int
68
69       Computes  the  total size (in words, including the headers) of all heap
70       blocks accessible from the argument.  Statically allocated  blocks  are
71       included.
72
73
74       Since 4.04
75
76
77
78       val field : t -> int -> t
79
80
81
82
83       val set_field : t -> int -> t -> unit
84
85       When using flambda:
86
87
88       set_field MUST NOT be called on immutable blocks.  (Blocks allocated in
89       C stubs, or with new_block below, are always considered mutable.)
90
91       The same goes for set_double_field .
92
93       For experts only: set_field et al can be made safe  by  first  wrapping
94       the  block  in  Sys.opaque_identity , so any information about its con‐
95       tents will not be propagated.
96
97
98
99       val compare_and_swap_field : t -> int -> t -> t -> bool
100
101
102
103
104       val is_shared : t -> bool
105
106
107
108
109       val double_field : t -> int -> float
110
111
112
113
114       val set_double_field : t -> int -> float -> unit
115
116
117
118
119       val raw_field : t -> int -> raw_data
120
121
122
123
124       val set_raw_field : t -> int -> raw_data -> unit
125
126
127
128
129       val new_block : int -> int -> t
130
131
132
133
134       val dup : t -> t
135
136
137
138
139       val add_offset : t -> Int32.t -> t
140
141
142
143
144       val with_tag : int -> t -> t
145
146
147
148
149       val first_non_constant_constructor_tag : int
150
151
152
153
154       val last_non_constant_constructor_tag : int
155
156
157
158
159       val forcing_tag : int
160
161
162
163
164       val cont_tag : int
165
166
167
168
169       val lazy_tag : int
170
171
172
173
174       val closure_tag : int
175
176
177
178
179       val object_tag : int
180
181
182
183
184       val infix_tag : int
185
186
187
188
189       val forward_tag : int
190
191
192
193
194       val no_scan_tag : int
195
196
197
198
199       val abstract_tag : int
200
201
202
203
204       val string_tag : int
205
206
207
208
209       val double_tag : int
210
211
212
213
214       val double_array_tag : int
215
216
217
218
219       val custom_tag : int
220
221
222
223
224       val int_tag : int
225
226
227
228
229       val out_of_heap_tag : int
230
231
232
233
234       val unaligned_tag : int
235
236
237
238       module Closure : sig end
239
240
241
242
243       module Extension_constructor : sig end
244
245
246
247
248       module Ephemeron : sig end
249
250
251
252
253
254
255
256OCamldoc                          2023-07-20                     Stdlib.Obj(3)