Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package ocaml-version
Manipulate, parse and generate OCaml version strings.
These are of the form major.minor.patch+extra, where the patch and extra fields are optional.
Core types and parsers and serializers
val v : ?patch:int -> ?extra:string -> int -> int -> tv ?patch ?extra major minor will construct an OCaml version string with the appropriate parameters. The patch and extra indicators are optional, but it is conventional to include a patch value of 0 for most recent OCaml releases.
val to_string : ?sep:char -> t -> stringto_string ?sep t will convert the version t into a human-readable representation. The sep will default to + which is the normal representation of extra version strings, but can be changed to another character by supplying sep. One such usecase is to generate Docker container tags from OCaml version strings, where only dashes and alphanumeric characters are allowed.
of_string t will parse the version string in t. The return value is compatible with the Result combinators defined in the rresult library.
val of_string_exn : string -> tof_string_exn t behaves as of_string but raises Invalid_argument if the string cannot be parsed.
compare a b is the comparison function for two OCaml version strings. Returns -1 if a<b, 0 if they are equal and 1 if a>b. Comparison is done using integer comparison for the major, minor and patch versions, and lexical comparison for any extra version strings present.
val pp : Format.formatter -> t -> unitpp fmt t will output a human-readable version string of t to the fmt formatter.
Architecture Support
These definitions cover the CPU architectures that OCaml runs and is supported on.
Type of CPU architectures. TODO: This is currently an incomplete list, and lists just those used by the opam test systems. Contributions welcome to complete it.
val string_of_arch : arch -> stringstring_of_arch arch will convert arch into a human-readable CPU architecture string. The result will follow the GOARCH convention used by Golang.
arch_of_string t will parse the architecture string in t. The return value is compatible with the Result combinators defined in the rresult library. This function is liberal and will attempt to understand variants of the same architecture. For example, both aarch64 and arm64 are parsed into `Aarch64.
val arch_of_string_exn : string -> archarch_of_string_exn t is the same as arch_of_string, except that it raises Invalid_argument in case of error.
Accessors
val major : t -> intmajor t will return the major version number of an OCaml release. For example, of_string "4.03.0" |> major will return 4.
val minor : t -> intminor t will return the minor version number of an OCaml release. For example, of_string "4.03.0" |> minor will return 3.
val patch : t -> int optionpatch t will return the patch version number of an OCaml release. For example, of_string "4.03.0" |> minor will return Some 0.
val extra : t -> string optionextra t will return the additional information string of an OCaml release. For example, of_string "4.03.0+flambda" |> extra will return Some "flambda".
with_variant t extra will return a fresh value with the extra version information in the OCaml string to extra, and remove it if None is supplied.
Constants
val sys_version : tsys_version is the version of OCaml that this library is currently compiled with, which will be the same as Sys.ocaml_version.
module Releases : sig ... endValues representing official releases of OCaml.
Feature Selection
module Since : sig ... endDetermine which release a feature or architecture first appeared in.
module Has : sig ... endTest whether a release has a given feature.
module Opam : sig ... endOpam compiler switches. These are available from the public opam-repository.