/usr/lib/ocaml/biniou/bi_vint.mli is in libbiniou-ocaml-dev 1.0.0-1build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 | (* $Id: bi_vint.mli 60 2010-12-03 09:53:06Z mjambon $ *)
(** Vint: variable-length representation of integers *)
(**
This module currently provides only conversions between vint and the
OCaml int type. Here are the current limits of OCaml ints on
32-bit and 64-bit systems:
{v
word length (bits) 32 64
int length (bits) 31 63
min_int (lowest signed int) 0x40000000 0x4000000000000000
-1073741824 -4611686018427387904
max_int (greatest signed int) 0x3fffffff 0x3fffffffffffffff
1073741823 4611686018427387903
lowest unsigned int 0x0 0x0
0 0
greatest unsigned int 0x7fffffff 0x7fffffffffffffff
2147483647 9223372036854775807
maximum vint length (data bits) 31 63
maximum vint length (total bytes) 5 9
v}
*)
type uint = int
(** Unsigned int.
Note that ints (signed) and uints use the same representation
for integers within \[0, [max_int]\].
*)
val uvint_of_uint : ?buf:Bi_outbuf.t -> uint -> string
(** Convert an unsigned int to a vint.
@param buf existing output buffer that could be reused by this function
instead of creating a new one. *)
val svint_of_int : ?buf:Bi_outbuf.t -> int -> string
(** Convert a signed int to a vint.
@param buf existing output buffer that could be reused by this function
instead of creating a new one. *)
val uint_of_uvint : string -> uint
(** Interpret a vint as an unsigned int.
@raise Bi_util.Error if the input string is not a single valid uvint
that is representable using the uint type. *)
val int_of_svint : string -> int
(** Interpret a vint as a signed int.
@raise Bi_util.Error if the input string is not a single valid svint
that is representable using the int type. *)
val write_uvint : Bi_outbuf.t -> uint -> unit
(** Write an unsigned int to a buffer. *)
val write_svint : Bi_outbuf.t -> int -> unit
(** Write a signed int to a buffer. *)
val read_uvint : Bi_inbuf.t -> uint
(** Read an unsigned int from a buffer.
@raise Bi_util.Error if there is no data to read from or if the
uvint is not representable using the uint type. *)
val read_svint : Bi_inbuf.t -> int
(** Read a signed int from a buffer.
@raise Bi_util.Error if there is no data to read from or if the
svint is not representable using the int type. *)
|