package octez-libs

You can search for identifiers within the package.

in-package search v0.2.0

A package that contains multiple base libraries used by the Octez suite

Install

Dune Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

T

Tezos devteam

Maintainers

C

contact@tezos.com

Sources

tezos-18.0.tar.gz

sha256=dbc3b675aee59c2c574e5d0a771193a2ecfca31e7a5bc5aed66598080596ce1c

sha512=b97ed762b9d24744305c358af0d20f394376b64bfdd758dd4a81775326caf445caa57c4f6445da3dd6468ff492de18e4c14af6f374dfcbb7e4d64b7b720e5e2a

doc/octez-libs.base/Tezos_base/Bounded/Int31/index.html

Module `Bounded.Int31`Source

Allows to build interval of built-in OCaml int integers. The encoding used is Data_encoding.int31 regardless of the actual bounds.

raises Invalid_argument
if the bounds provided cannot be representable on 4 bytes (depends on whether int is represented on 4 bytes or 8 bytes which depends on the machine architecture)..

Parameters

module B : BOUNDS with type ocaml_type := int

Signature

Sourcetype t

Internal representation of a bounded value.

include BOUNDS with type ocaml_type := int

val min_value : int

min_value represents the minimal value (included) reprensatable.

val max_value : int

max_value represents the maximal value (included) reprensatable.

include Tezos_stdlib.Compare.S with type t := t

Sourceval (=) : t -> t -> bool

x = y iff compare x y = 0

Sourceval (<>) : t -> t -> bool

x <> y iff compare x y <> 0

Sourceval (<) : t -> t -> bool

x < y iff compare x y < 0

Sourceval (<=) : t -> t -> bool

x <= y iff compare x y <= 0

Sourceval (>=) : t -> t -> bool

x >= y iff compare x y >= 0

Sourceval (>) : t -> t -> bool

x > y iff compare x y > 0

Sourceval compare : t -> t -> int

compare an alias for the functor parameter's compare function

Sourceval equal : t -> t -> bool

equal x y iff compare x y = 0

Sourceval max : t -> t -> t

max x y is x if x >= y otherwise it is y

Sourceval min : t -> t -> t

min x y is x if x <= y otherwise it is y

Sourceval encoding : t Data_encoding.t

A (partial) encoding of the datatype. If the encoded value is out of bounds, an exception may be raised. See Data_encoding.conv_with_guard.

Sourceval pp : Format.formatter -> t -> unit

A pretty-printer for values of type t.

Sourceval to_value : t -> int

to_value t is a projection to the OCaml representation of the bounded value t.

Sourceval of_value : int -> t option

of_value ocaml_value represents ocaml_value as a bounded value. Returns None if the value is outside of the bounds specified by min_value and max_value.

On This Page

Parameters
Signature