Module `Obj.Uniform_or_mixed`Source

Blocks with a nominally scannable tag can still have a suffix of unscanned objects; such a block is "mixed". This contrasts with "uniform" blocks which are either all-scanned or all-unscanned.

Note that this module can return different results for the scannable prefix len of a mixed block in native code vs. bytecode. That's because more fields are scanned in bytecode.

type obj_t := Stdlib.Obj.t

Sourcetype t

Sourcetype repr =

| Uniform
(*
The block is tagged as not scannable or the block is tagged as scannable and all fields can be scanned.
*)
| Mixed of {
1. scannable_prefix_len : int;
}
(*
The block is tagged as scannable but some fields can't be scanned.
*)

Sourceval repr : Stdlib.Obj.Uniform_or_mixed.t -> Stdlib.Obj.Uniform_or_mixed.repr

Source

val of_block : 
  Stdlib.Obj.Uniform_or_mixed.obj_t ->
  Stdlib.Obj.Uniform_or_mixed.t

Sourceval is_uniform : Stdlib.Obj.Uniform_or_mixed.t -> bool

Equivalent to repr returning Uniform.

Sourceval is_mixed : Stdlib.Obj.Uniform_or_mixed.t -> bool

Equivalent to repr returning Mixed _.

Sourceval mixed_scannable_prefix_len_exn : Stdlib.Obj.Uniform_or_mixed.t -> int

Returns the scannable_prefix_len without materializing the return value of repr. Raises if is_mixed is false.

Module Obj.Uniform_or_mixedSource

Module `Obj.Uniform_or_mixed`Source