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 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.12.2.tar.gz

sha256=96750d5b097cdfcdf00a463e2c1083e3c62c1d92987a0751ca2cda3a1e09241f

md5=afc0271c35437c883b3c75fb821fe470

doc/core_kernel.uopt/Uopt/index.html

Module `Uopt`

A Uopt.t is an unboxed option. This module is tricky and potentially unsafe. It should mostly not be used, and when it is, one must keep the Uopt.t inside their module, and not expose them (not even if they are given an abstract type).

'a Uopt.t is like 'a option, but doesn't box some values. It must not be used in a nested way, i.e. as 'a Uopt.t Uopt.t. It must also not be used for float Uopt.t array, since the representation of the array would vary depending on whether none or some is used to create the array. It should also not be used in a record that contains only floats and float Uopt.ts, because the compiler would treat that as a float-only record and would unbox the record fields.

The type is exposed as private 'a so the compiler can infer that an 'a t can't be a float in the right context, thus avoiding runtime checks in _ Uopt.t arrays. Using :> is of course unsafe. Because Uopt.none cannot be garbage collected, there is no problem if the compiler decides to skip write barriers (when 'a is an immediate).

type 'a t = private 'a

val sexp_of_t : 
  ('a -> Ppx_sexp_conv_lib.Sexp.t) ->
  'a t ->
  Ppx_sexp_conv_lib.Sexp.t

include Core_kernel.Invariant.S1 with type 'a t := 'a t

val invariant : ('a -> unit) -> 'a t -> unit

val none : _ t

val some : 'a -> 'a t

val is_none : _ t -> bool

val is_some : _ t -> bool

val value_exn : 'a t -> 'a

val unsafe_value : 'a t -> 'a

It is safe to call unsafe_value t iff is_some t.