package plebeia

  1. Overview
  2. Docs
package plebeia
Legend:
Library
Module
Module type
Parameter
Class
Class type

1 Index in data files

type t = private int

2 Constants

The zero index is treated specially.

val zero : t
val one : t
val max_int : t
val zero_then_none : t -> t option

This function returns None if t is zero.

2 Arithmetics

val pred : t -> t
val succ : t -> t
val (-) : t -> t -> t
val (+) : t -> t -> t
val (*) : t -> t -> t
val (/) : t -> t -> t
val compare : t -> t -> int
val max : t -> t -> t
val min : t -> t -> t

2 Conversion to integer types

val to_int64 : t -> int64
val of_int64 : int64 -> t
val to_int : t -> int
val of_int : int -> t
val of_uint32 : Stdint.Uint32.t -> t
val to_uint32 : t -> Stdint.Uint32.t
module Unsafe : sig ... end

These conversions may underflow/overflow. Use with caution.

2 Set and Map

module Set : sig ... end
module Map : sig ... end
val pp : Format.formatter -> t -> unit

2 Printing

val to_bytes_big_endian : t -> Bytes.t -> int -> unit

encoding

val of_bytes_big_endian : Bytes.t -> int -> t