package core

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

Module Stable.V3Source

Sourcetype nonrec t = t

Fully round-trippable format, which does not use float multiplication or division to serialize or deserialize % or bp but instead does string manipulation.

Note that as a consequence, this may yield ugly-looking output for Percent.t values obtained as a result of a calculation, including Percent.of_percentage, because of accumulated floating-point rounding errors. Use Almost_round_trippable when the esthetics (aka human readability) of the output is more important than exact round-trippability.

Also note that Percent.Stable.V3.t_of_sexp and Percent.Stable.V2.t_of_sexp may yield results off by one ulp because the latter does the division by 100.0 or 10,000.0 in the '%' or 'bp' case, respectively.

For example,

 stable.V3.of_string "17.33%" <> of_percentage 17.33 
include Sexplib0.Sexpable.S with type t := t
Sourceval t_of_sexp : Sexplib0.Sexp.t -> t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval t_sexp_grammar : t Sexplib0.Sexp_grammar.t
include 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
include Ppx_compare_lib.Comparable.S with type t := t
Sourceval globalize : t -> t
include Ppx_hash_lib.Hashable.S with type t := t
Sourceval hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
include Ppx_compare_lib.Equal.S with type t := t
Sourceval stable_witness : t Ppx_stable_witness_runtime.Stable_witness.t
Sourcemodule Diff : sig ... end
include Interfaces.Comparable_binable with type t := t and type comparator_witness := comparator_witness
include Base.Comparable.S with type t := t with type comparator_witness := comparator_witness
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 with type comparator_witness := comparator_witness
Sourceval validate_lbound : min:t Maybe_bound.t -> t Validate.check
Sourceval validate_ubound : max:t Maybe_bound.t -> t Validate.check
Sourceval validate_bound : min:t Maybe_bound.t -> max:t Maybe_bound.t -> t Validate.check
Sourceval to_string : t -> Base.String.t
Sourceval of_string : Base.String.t -> t
Sourceval of_string_allow_nan_and_inf : Base.String.t -> t
Sourcemodule Always_percentage : sig ... end

A variant with alternative serialization, which always uses the % format, regardless of the absolute value of t. Fully inter-operable with Percent.Stable.V3.t: either can read the other's output and it's fully round-trippable in both directions.

OCaml

Innovation. Community. Security.