package core

  1. Overview
  2. Docs
package core
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file immediate_option_intf.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
(** A non-allocating alternative to the standard Option type. *)

open! Import

module type S_without_immediate_plain = sig
  (** The immediate value carried by the immediate option.

      Given the presence of {!unchecked_value}, the [value] type should not have
      operations that depend on the value's validity for memory safety.  In particular,
      [unchecked_value] is not called [unsafe_value] as it would be if it could return a
      value that later resulted in a segmentation fault.  For pointer-like values, use
      {!Ext.Nullable}, for example. *)
  type value

  (** Represents [value option] without allocating a [Some] tag. The interface does not
      enforce that [t] is immediate because some types, like [Int63.t], are only immediate
      on 64-bit platforms. For representations whose type is immediate, use [S] below
      which adds the [[@@immediate]] annotation. *)
  type t

  (** Constructors analogous to [None] and [Some].  If [not (some_is_representable x)]
      then [some x] may raise or return [none]. *)

  val none : t
  val some : value -> t

  (** For some representations of immediate options, the encodings of [none] and [some]
      overlap.  For these representations, [some_is_representable value = false] if
      [value] cannot be represented as an option.  For example, [Int.Option] uses
      [min_value] to represent [none].  For other representations, [some_is_representable]
      always returns [true]. *)
  val some_is_representable : value -> bool

  val is_none : t -> bool
  val is_some : t -> bool

  (** [value (some x) ~default = x] and [value none ~default = default]. *)
  val value : t -> default:value -> value

  (** [value_exn (some x) = x].  [value_exn none] raises.  Unlike [Option.value_exn],
      there is no [?message] argument, so that calls to [value_exn] that do not raise
      also do not have to allocate. *)
  val value_exn : t -> value

  (** [unchecked_value (some x) = x].  [unchecked_value none] returns an unspecified
      value.  [unchecked_value t] is intended as an optimization of [value_exn t] when
      [is_some t] is known to be true. *)
  val unchecked_value : t -> value

  val to_option : t -> value option
  val of_option : value option -> t

  module Optional_syntax : Optional_syntax.S with type t := t with type value := value
end

module type S_without_immediate = sig
  type t [@@deriving compare, hash, sexp_of, typerep]

  include S_without_immediate_plain with type t := t
end

module type S_plain = sig
  type t [@@immediate]

  include S_without_immediate_plain with type t := t
end

module type S = sig
  type t [@@immediate]

  include S_without_immediate with type t := t
end

module type S_int63 = sig
  type t [@@immediate64]

  include S_without_immediate with type t := t
end

module type S_int63_plain = sig
  type t [@@immediate64]

  include S_without_immediate_plain with type t := t
end

module type Immediate_option = sig
  (** Always immediate. *)
  module type S = S

  module type S_plain = S_plain

  (** Immediate only on 64-bit machines. *)
  module type S_int63 = S_int63

  module type S_int63_plain = S_int63_plain

  (** Never immediate. *)
  module type S_without_immediate = S_without_immediate

  module type S_without_immediate_plain = S_without_immediate_plain
end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct