package core_extended
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=17de5f7cf59818d757bb0625c55f0afc84509122645b7782fb522ac98c3be446
doc/core_extended.immediate/Immediate/String/Option/index.html
Module String.Option
Source
include Immediate_kernel.Option with type value := t
include Core.Immediate_option.S with type value := t
include Core.Immediate_option_intf.S_without_immediate
with type t := t
with type value := t
include Ppx_compare_lib.Comparable.S with type t := t
include Ppx_hash_lib.Hashable.S with type t := t
include Core.Immediate_option_intf.S_without_immediate_plain
with type t := t
with type value := t
Constructors analogous to None
and Some
. If not (some_is_representable x)
then some x
may raise or return none
.
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
.
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.
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.
include Core.Identifiable.S with type t := t
include Bin_prot.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
This function only needs implementation if t
exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t
afterwards.
include Ppx_hash_lib.Hashable.S with type t := t
include Sexplib0.Sexpable.S with type t := t
include Ppx_compare_lib.Comparable.S with type t := t
include Ppx_hash_lib.Hashable.S with type t := t
include Base.Pretty_printer.S with type t := t
include Core.Comparable.S_binable with type t := t
include Base.Comparable.S with type t := t
include Base.Comparisons.S with type t := t
compare t1 t2
returns 0 if t1
is equal to t2
, a negative integer if t1
is less than t2
, and a positive integer if t1
is greater than t2
.
ascending
is identical to compare
. descending x y = ascending y x
. These are intended to be mnemonic when used like List.sort ~compare:ascending
and List.sort ~cmp:descending
, since they cause the list to be sorted in ascending or descending order, respectively.
clamp_exn t ~min ~max
returns t'
, the closest value to t
such that between t' ~low:min ~high:max
is true.
Raises if not (min <= max)
.
include Base.Comparator.S with type t := t
include Core.Comparator.S
with type t := t
with type comparator_witness := comparator_witness
module Map :
Core.Map.S_binable
with type Key.t = t
with type Key.comparator_witness = comparator_witness
module Set :
Core.Set.S_binable
with type Elt.t = t
with type Elt.comparator_witness = comparator_witness