package core_kernel

  1. Overview
  2. Docs
Industrial strength alternative to OCaml's standard library

Install

Dune Dependency

Authors

Maintainers

Sources

v0.12.3.tar.gz
sha256=c9969799846cf1c40ddc691ef7e977fbb77d0e93d0461a632e207a40b7002f78
md5=f4afcf23e7dfd7de8e292ce37cdd3301

doc/core_kernel.weak_pointer/Weak_pointer/index.html

Module Weak_pointer

A weak pointer is a pointer to a heap block that does not cause the heap block to remain live during garbage collection.

If the block would otherwise remain live, then the weak pointer remains pointed to the block. If the block is collected, then the weak pointer is cleared.

type 'a t
val sexp_of_t : ('a -> Ppx_sexp_conv_lib.Sexp.t) -> 'a t -> Ppx_sexp_conv_lib.Sexp.t
val create : unit -> _ t

create creates an empty weak pointer. One must set it to point it to something.

val get : 'a t -> 'a Core_kernel.Heap_block.t option
val is_some : _ t -> bool

is_some t = Option.is_some (get t).

val is_none : _ t -> bool

is_none t = Option.is_none (get t).

val set : 'a t -> 'a Core_kernel.Heap_block.t -> unit
OCaml

Innovation. Community. Security.