package octez-libs

  1. Overview
  2. No Docs
A package that contains multiple base libraries used by the Octez suite

Install 

dune-project
 Dependency

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

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

tezos-18.1.tar.gz
sha256=aa2f5bc99cc4ca2217c52a1af2a2cdfd3b383208cb859ca2e79ca0903396ca1d
sha512=d68bb3eb615e3dcccc845fddfc9901c95b3c6dc8e105e39522ce97637b1308a7fa7aa1d271351d5933febd7476b2819e1694f31198f1f0919681f1f9cc97cb3a

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

Module Bounded.Uint8Source

Allows to build interval of non-negative int integers representable on 1 bytes. The encoding used is Data_encoding.uint8 regardless of the actual bounds.

  • raises Invalid_argument

    if the bounds provided cannot be representable on 1 bytes.

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.