Module Date.Option
include Immediate_option_intf.S with type value := t
include Immediate_option_intf.S_without_immediate with type t := t
val compare : t -> t -> Core_kernel__.Import.int
val hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
val hash : t -> Base.Hash.hash_value
val sexp_of_t : t -> Ppx_sexp_conv_lib.Sexp.t
include Typerep_lib.Typerepable.S with type t := t
val typerep_of_t : t Typerep_lib.Std_internal.Typerep.t
val typename_of_t : t Typerep_lib.Typename.t
include Immediate_option_intf.S_without_immediate_plain with type t := t
type value
The immediate value carried by the immediate option.
Given the presence of
unchecked_value
, thevalue
type should not have operations that depend on the value's validity for memory safety. In particular,unchecked_value
is not calledunsafe_value
as it would be if it could return a value that later resulted in a segmentation fault. For pointer-like values, useExt
.Nullable, for example.
type t
Represents
value option
without allocating aSome
tag. The interface does not enforce thatt
is immediate because some types, likeInt63.t
, are only immediate on 64-bit platforms. For representations whose type is immediate, useS
below which adds the[@@immediate]
annotation.
val none : t
val some : value -> t
val some_is_representable : value -> Core_kernel__.Import.bool
For some representations of immediate options, the encodings of
none
andsome
overlap. For these representations,some_is_representable value = false
ifvalue
cannot be represented as an option. For example,Int.Option
usesmin_value
to representnone
. For other representations,some_is_representable
always returnstrue
.
val is_none : t -> Core_kernel__.Import.bool
val is_some : t -> Core_kernel__.Import.bool
val value : t -> default:value -> value
value (some x) ~default = x
andvalue none ~default = default
.
val value_exn : t -> value
value_exn (some x) = x
.value_exn none
raises. UnlikeOption.value_exn
, there is no?message
argument, so that calls tovalue_exn
that do not raise also do not have to allocate.
val unchecked_value : t -> value
unchecked_value (some x) = x
.unchecked_value none
returns an unspecified value.unchecked_value t
is intended as an optimization ofvalue_exn t
whenis_some t
is known to be true.
val to_option : t -> value Core_kernel__.Import.option
val of_option : value Core_kernel__.Import.option -> t
module Optional_syntax : Optional_syntax.S with type t := t with type value := value
include Comparable.S_plain with type t := t
include Core_kernel__.Comparable_intf.S_common
include Base.Comparable.S
include Base__.Comparable_intf.Polymorphic_compare
val ascending : t -> t -> int
ascending
is identical tocompare
.descending x y = ascending y x
. These are intended to be mnemonic when used likeList.sort ~compare:ascending
andList.sort ~cmp:descending
, since they cause the list to be sorted in ascending or descending order, respectively.
val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool
between t ~low ~high
meanslow <= t <= high
val clamp_exn : t -> min:t -> max:t -> t
clamp_exn t ~min ~max
returnst'
, the closest value tot
such thatbetween t' ~low:min ~high:max
is true.Raises if
not (min <= max)
.
val clamp : t -> min:t -> max:t -> t Base.Or_error.t
include Base.Comparator.S with type t := t
val comparator : (t, comparator_witness) Base.Comparator.comparator
include Base__.Comparable_intf.Validate with type t := t
val validate_lbound : min:t Base.Maybe_bound.t -> t Base.Validate.check
val validate_ubound : max:t Base.Maybe_bound.t -> t Base.Validate.check
val validate_bound : min:t Base.Maybe_bound.t -> max:t Base.Maybe_bound.t -> t Base.Validate.check
module Replace_polymorphic_compare : Core_kernel__.Comparable_intf.Polymorphic_compare with type t := t
module Map : Map.S_plain with type Key.t = t with type Key.comparator_witness = comparator_witness
module Set : Set.S_plain with type Elt.t = t with type Elt.comparator_witness = comparator_witness
include Quickcheckable.S with type t := t
val quickcheck_generator : t Base_quickcheck.Generator.t
val quickcheck_observer : t Base_quickcheck.Observer.t
val quickcheck_shrinker : t Base_quickcheck.Shrinker.t