package core

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type 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
val t_of_sexp : Sexplib0__.Sexp.t -> t
val sexp_of_t : t -> Sexplib0__.Sexp.t
val 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
val bin_size_t : t Bin_prot.Size.sizer
val bin_write_t : t Bin_prot.Write.writer
val bin_read_t : t Bin_prot.Read.reader
val __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.

val bin_shape_t : Bin_prot.Shape.t
val bin_writer_t : t Bin_prot.Type_class.writer
val bin_reader_t : t Bin_prot.Type_class.reader
include Ppx_compare_lib.Comparable.S with type t := t
val globalize : t -> t
include Ppx_hash_lib.Hashable.S with type t := t
val hash_fold_t : t Base__Ppx_hash_lib.hash_fold
val hash : t -> Base__Ppx_hash_lib.Std.Hash.hash_value
include Ppx_compare_lib.Equal.S with type t := t
include Typerep_lib.Typerepable.S with type t := t
val typename_of_t : t Typerep_lib.Typename.t
module 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
val (>=) : t -> t -> bool
val (<=) : t -> t -> bool
val (=) : t -> t -> bool
val (>) : t -> t -> bool
val (<) : t -> t -> bool
val (<>) : t -> t -> bool
val equal : t -> t -> bool
val compare : t -> t -> int
val min : t -> t -> t
val max : t -> t -> t
val ascending : t -> t -> int
val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool
val clamp_exn : t -> min:t -> max:t -> t
val clamp : t -> min:t -> max:t -> t Base__.Or_error.t
val validate_lbound : min:t Maybe_bound.t -> t Validate.check
val validate_ubound : max:t Maybe_bound.t -> t Validate.check
val validate_bound : min:t Maybe_bound.t -> max:t Maybe_bound.t -> t Validate.check
module Replace_polymorphic_compare : sig ... end
include Comparator.S with type t := t with type comparator_witness := comparator_witness
val to_string : t -> Base.String.t
val of_string : Base.String.t -> t
val of_string_allow_nan_and_inf : Base.String.t -> t
module 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.