package core_kernel

You can search for identifiers within the package.

in-package search v0.2.0

Industrial strength alternative to OCaml's standard library

Install

dune-project

Dependency

github.com Readme Changelog MIT License Edit opam file Versions (10)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

v0.14.1.tar.gz

sha256=1d91a0d58e9a98809eb3bc888ae716e786c68ad5d07a874c37d9c1ef9fd24438

md5=77b25affd5155128ca757d38e496d89f

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