Module Stdlib.Obj

Instructions: Use this module in your project

In the IDE (CLion, Visual Studio Code, Xcode, etc.) you use for your DkSDK project:

Add the following to your project's dependencies/CMakeLists.txt:

Copy

DkSDKProject_DeclareAvailable(ocaml
    CONSTRAINT "= 4.14.0"
    FINDLIBS str unix runtime_events threads dynlink)
DkSDKProject_MakeAvailable(ocaml)

Add the Findlib::ocaml library to any desired targets in src/*/CMakeLists.txt:

Copy

target_link_libraries(YourPackage_YourLibraryName
     # ... existing libraries, if any ...
     Findlib::ocaml)

Click your IDE's Build button

Not using DkSDK?

FIRST, do one or all of the following:

Run:
Copy
```
opam install ocaml.4.14.0
```

Edit your dune-project and add:

Copy

(package
  (name YourExistingPackage)
  (depends
  ; ... existing dependenices ...
  (ocaml (>= 4.14.0))))

Then run:

Copy

dune build *.opam # if this fails, run: dune build

Edit your <package>.opam file and add:

Copy

depends: [
  # ... existing dependencies ...
  "ocaml" {>= "4.14.0"}
]

Then run:

Copy

opam install . --deps-only

FINALLY, add the library to any desired (library)and/or (executable) targets in your **/dune files:

Copy

(library
  (name YourLibrary)
  ; ... existing library options ...
  (libraries
    ; ... existing libraries ...
    ))

(executable
  (name YourExecutable)
  ; ... existing executable options ...
  (libraries
    ; ... existing libraries ...
    ))

type t

type raw_data`` = nativeint

valrepr :'a -> t

valobj :t -> 'a

valmagic :'a -> 'b

valis_block :t -> bool

valis_int :t -> bool

valtag :t -> int

valsize :t -> int

valreachable_words :t -> int

Computes the total size (in words, including the headers) of all heap blocks accessible from the argument. Statically allocated blocks are excluded, unless the runtime system was configured with --disable-naked-pointers.

since 4.04

valfield :t ->``int-> t

valset_field :t ->``int-> t -> unit

When using flambda:

set_field MUST NOT be called on immutable blocks. (Blocks allocated in C stubs, or with new_block below, are always considered mutable.)

The same goes for set_double_field and set_tag. However, for set_tag, in the case of immutable blocks where the middle-end optimizers never see code that discriminates on their tag (for example records), the operation should be safe. Such uses are nonetheless discouraged.

For experts only: set_field et al can be made safe by first wrapping the block in Sys.opaque_identity, so any information about its contents will not be propagated.

valset_tag :t ->``int-> unit

deprecated Use with_tag instead.

valdouble_field :t ->``int-> float

valset_double_field :t ->``int->``float-> unit

valraw_field :t ->``int-> raw_data

valset_raw_field :t ->``int-> raw_data -> unit

valnew_block : ``int->``int-> t

valdup :t -> t

valtruncate :t ->``int-> unit

deprecated

valadd_offset :t -> Int32.t -> t

valwith_tag : ``int-> t -> t

val first_non_constant_constructor_tag : int

val last_non_constant_constructor_tag : int

val lazy_tag : int

val closure_tag : int

val object_tag : int

val infix_tag : int

val forward_tag : int

val no_scan_tag : int

val abstract_tag : int

val string_tag : int

val double_tag : int

val double_array_tag : int

val custom_tag : int

val final_tag : int

deprecated Replaced by custom_tag.

val int_tag : int

val out_of_heap_tag : int

val unaligned_tag : int

module Closure:sig...end

module Extension_constructor:sig...end

valextension_constructor :'a -> extension_constructor

deprecated use Obj.Extension_constructor.of_val

valextension_name : ``extension_constructor-> string

deprecated use Obj.Extension_constructor.name

valextension_id : ``extension_constructor-> int

deprecated use Obj.Extension_constructor.id

module Ephemeron:sig...end

Ephemeron with arbitrary arity and untyped

More from the DkSDK Book

1. DkSDK
1. 1. Package capnp
  1. 1. Module Capnp
    1. Module Capnp_unix
  1. Package cmdliner
  1. 1. Module Cmdliner
    1. Module Cmdliner_arg
    1. Module Cmdliner_base
    1. Module Cmdliner_cline
    1. Module Cmdliner_cmd
    1. Module Cmdliner_docgen
    1. Module Cmdliner_eval
    1. Module Cmdliner_info
    1. Module Cmdliner_manpage
    1. Module Cmdliner_msg
    1. Module Cmdliner_term
    1. Module Cmdliner_term_deprecated
    1. Module Cmdliner_trie
  1. Package fmt
  1. 1. Module Fmt
    1. Module Fmt_cli
    1. Module Fmt_tty
  1. Package logs
  1. 1. Module Logs
    1. Module Logs_cli
    1. Module Logs_fmt
    1. Module Logs_lwt
    1. Module Logs_threaded
  1. Package lwt
  1. 1. Module Lwt
    1. Module Lwt_bytes
    1. Module Lwt_condition
    1. Module Lwt_config
    1. Module Lwt_engine
    1. Module Lwt_features
    1. Module Lwt_fmt
    1. Module Lwt_gc
    1. Module Lwt_io
    1. Module Lwt_list
    1. Module Lwt_main
    1. Module Lwt_mutex
    1. Module Lwt_mvar
    1. Module Lwt_pool
    1. Module Lwt_pqueue
    1. Module Lwt_preemptive
    1. Module Lwt_process
    1. Module Lwt_result
    1. Module Lwt_seq
    1. Module Lwt_sequence
    1. Module Lwt_stream
    1. Module Lwt_switch
    1. Module Lwt_sys
    1. Module Lwt_throttle
    1. Module Lwt_timeout
    1. Module Lwt_unix
  1. Package mtime
  1. 1. Module Mtime
    1. Module Mtime_clock
  1. Package ocaml
  1. 1. Module Bigarray
    1. Module Condition
    1. Module Dynlink
    1. Module Event
    1. Module Mutex
    1. Module Profiling
    1. Module Semaphore
    1. Module Stdlib
    1. 1. ...
      1. Module Stdlib.Obj
      1. Module Obj.Closure
        Module Obj.Ephemeron
        Module Obj.Extension_constructor
    1. Module Str
    1. Module Thread
    1. Module ThreadUnix
    1. Module Topdirs
    1. Module Unix
    1. Module UnixLabels
  1. Package
  1. Package result
  1. 1. Module Result
  1. Package stdint
  1. 1. Module Stdint