Module `Flags.Make_binable`Source

Similar to Flags.Make, but the resulting type t is binable.

Parameters

module M : Make_arg

Signature

Sourcetype t = Core.Int63.t

include Core.Bin_prot.Binable.S with type t := t

include Bin_prot.Binable.S_only_functions with type t := t

Sourceval bin_size_t : t Bin_prot.Size.sizer

Sourceval bin_write_t : t Bin_prot.Write.writer

Sourceval bin_read_t : t Bin_prot.Read.reader

Sourceval __bin_read_t__ : (int -> t) Bin_prot.Read.reader

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.

Sourceval bin_shape_t : Bin_prot.Shape.t

Sourceval bin_writer_t : t Bin_prot.Type_class.writer

Sourceval bin_reader_t : t Bin_prot.Type_class.reader

Sourceval bin_t : t Bin_prot.Type_class.t

include Sexplib0.Sexpable.S with type t := t

Sourceval t_of_sexp : Sexplib0.Sexp.t -> t

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t

include Typerep_lib.Typerepable.S with type t := t

Sourceval typerep_of_t : t Typerep_lib.Std_internal.Typerep.t

Sourceval typename_of_t : t Typerep_lib.Typename.t

consistent with subset

include Core.Comparable.S with type t := t

include Base.Comparable.S with type t := t

include Base.Comparisons.S with type t := t

include Base.Comparisons.Infix with type t := t

Sourceval (>=) : t -> t -> bool

Sourceval (<=) : t -> t -> bool

Sourceval (=) : t -> t -> bool

Sourceval (>) : t -> t -> bool

Sourceval (<) : t -> t -> bool

Sourceval (<>) : t -> t -> bool

Sourceval equal : t -> t -> bool

Sourceval compare : t -> t -> int

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.

Sourceval min : t -> t -> t

Sourceval max : t -> t -> t

Sourceval ascending : t -> t -> int

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.

Sourceval descending : t -> t -> int

Sourceval between : t -> low:t -> high:t -> bool

between t ~low ~high means low <= t <= high

Sourceval clamp_exn : t -> min:t -> max:t -> t

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).

Sourceval clamp : t -> min:t -> max:t -> t Base.Or_error.t

include Base.Comparator.S with type t := t

Sourcetype comparator_witness

Sourceval comparator : (t, comparator_witness) Base.Comparator.comparator

Sourceval validate_lbound : min:t Core.Maybe_bound.t -> t Validate.check

Sourceval validate_ubound : max:t Core.Maybe_bound.t -> t Validate.check

Source

val validate_bound : 
  min:t Core.Maybe_bound.t ->
  max:t Core.Maybe_bound.t ->
  t Validate.check

Source

module Replace_polymorphic_compare : 
  Base.Comparable.Comparisons with type t := t

Source

module Map : 
  Core.Map.S
    with type Key.t = t
    with type Key.comparator_witness = comparator_witness

Source

module Set : 
  Core.Set.S
    with type Elt.t = t
    with type Elt.comparator_witness = comparator_witness

Sourceval to_flag_list : t -> t * string list

Sourceval of_int : int -> t

Sourceval to_int_exn : t -> int

Sourceval empty : t

Sourceval (+) : t -> t -> t

set union, bitwise or

Sourceval (-) : t -> t -> t

set difference. Although we use operators + and -, they do not satisfy the usual arithmetic equations, e.g. x - y = x + (empty - y) does not hold.

Sourceval intersect : t -> t -> t

bitwise and

Sourceval complement : t -> t

bitwise not

Sourceval is_empty : t -> bool

Sourceval do_intersect : t -> t -> bool

Sourceval are_disjoint : t -> t -> bool

Sourceval is_subset : t -> of_:t -> bool

is_subset t ~of_ is t = intersect t of_

Sourcemodule Unstable : sig ... end

Install

Dune Dependency

Authors

Maintainers

Sources

doc/core_kernel.flags/Flags/Make_binable/index.html

Module `Flags.Make_binable`Source

Parameters

Signature

package core_kernel

Install

Dune Dependency

Authors

Maintainers

Sources

doc/core_kernel.flags/Flags/Make_binable/index.html

Module Flags.Make_binableSource

Parameters

Signature

Module `Flags.Make_binable`Source