Module type Core_kernel__.Immediate_option.Int63

type immediate

The immediate value used to implement the immediate option.

S should be used with immediate replaced by a concrete type so the compiler can optimize uses of t as an immediate value. For example, use S with type immediate := int or use the predefined instantiations below.

type value

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 Zero.Ext.Nullable, for example.

type t = private Base.Int63.t

Represents value option using immediate in order to avoid allocating a Some tag. Exports the representation so the compiler can optimize t as an immediate type, assuming immediate is known to be immediate. The interface does not enforce that immediate is immediate because some types, like Int63.t, are only immediate on 64-bit platforms.

include sig ... end
val typerep_of_t : t Typerep_lib.Std.Typerep.t
val typename_of_t : t Typerep_lib.Std.Typename.t
val sexp_of_t : t ‑> Sexplib.Sexp.t
val compare : t ‑> t ‑> Core_kernel__.Import.int
val none : t

Constructors analogous to None and Some.

val some : value ‑> t
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 and value none ~default = default.

val value_exn : t ‑> 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 unchecked_value : 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 to_option : t ‑> value Core_kernel__.Import.option
val of_option : value Core_kernel__.Import.option ‑> t
module Optional_syntax : sig ... end

Provides bindings used by the match%optional ppx transformer. Example: