Use private types in the interface

opam

@@ -1,4 +1,5 @@
 opam-version: "1.2"
+name: "usane"
 maintainer: "Hannes Mehnert <hannes@mehnert.org>"
 authors: ["Hannes Mehnert <hannes@mehnert.org>"]
 homepage: "https://github.com/hannesm/usane"

src/usane.ml

@@ -16,6 +16,8 @@ module Uint8 = struct
   external mul : t -> t -> t * bool = "caml__uint8_mul_overflow"
   external sub : t -> t -> t * bool = "caml__uint8_sub_overflow"
 
+  let zero = 0
+
   let pred t = sub t 1
 
   let succ t = add t 1
@@ -54,6 +56,8 @@ module Uint16 = struct
   external mul : t -> t -> t * bool = "caml__uint16_mul_overflow"
   external sub : t -> t -> t * bool = "caml__uint16_sub_overflow"
 
+  let zero = 0
+
   let pred t = sub t 1
 
   let succ t = add t 1
@@ -100,6 +104,8 @@ module Uint32 = struct
   external mul : t -> t -> t * bool = "caml_uint32_mul_overflow"
   external sub : t -> t -> t * bool = "caml_uint32_sub_overflow"
 
+  let zero = 0l
+
   let pred t = sub t 1l
 
   let succ t = add t 1l
@@ -144,6 +150,8 @@ module Uint64 = struct
   external mul : t -> t -> t * bool = "caml_uint64_mul_overflow"
   external sub : t -> t -> t * bool = "caml_uint64_sub_overflow"
 
+  let zero = 0L
+
   let pred t = sub t 1L
 
   let succ t = add t 1L

src/usane.mli

@@ -24,7 +24,7 @@
 module Uint8 : sig
 
   (** Type of an unsigned 8 bit integer.  It is represented as an [int]*)
-  type t = int
+  type t = private int
 
   (** [pp ppf u] prints the unsigned 8bit integer in hex encoding. *)
   val pp : Format.formatter -> t -> unit
@@ -55,6 +55,9 @@ module Uint8 : sig
       is [true], otherwise it is [false]. *)
   val pred : t -> t * bool
 
+  (** [zero] is [Uint8.of_int 0] *)
+  val zero : t
+
   (** [compare t t'] is
       {ul
       {- [-1] if [t] is smaller than [t'],}
@@ -88,7 +91,7 @@ end
 module Uint16 : sig
 
   (** Type of an unsigned 16 bit integer.  It is represented as an [int]*)
-  type t = int
+  type t = private int
 
   (** [pp ppf u] prints the unsigned 16bit integer in hex encoding. *)
   val pp : Format.formatter -> t -> unit
@@ -119,6 +122,9 @@ module Uint16 : sig
       is [true], otherwise it is [false]. *)
   val pred : t -> t * bool
 
+  (** [zero] is [Uint16.of_int 0] *)
+  val zero : t
+
   (** [compare t t'] is
       {ul
       {- [-1] if [t] is smaller than [t'],}
@@ -188,6 +194,9 @@ module Uint32 : sig
       is [true], otherwise it is [false]. *)
   val pred : t -> t * bool
 
+  (** [zero] is [Uint32.of_int 0] *)
+  val zero : t
+
   (** [compare t t'] is
       {ul
       {- [-1] if [t] is smaller than [t'],}
@@ -257,6 +266,9 @@ module Uint64 : sig
       is [true], otherwise it is [false]. *)
   val pred : t -> t * bool
 
+  (** [zero] is [Uint64.of_int 0] *)
+  val zero : t
+
   (** [compare t t'] is
       {ul
       {- [-1] if [t] is smaller than [t'],}