package tezos-base

  1. Overview
  2. Docs
Tezos: meta-package and pervasive type definitions for Tezos

Install 

dune-project
 Dependency

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

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

tezos-16.1.tar.gz
sha256=43723d096307603703a1a89ed1b2eb202b365f5e7824b96b0cbf813b343a6cf7
sha512=b2a637f2e965000d3d49ad85277ca24d6cb07a1a7cf2bc69d296d8b03ad78c3eaa8e21e94b9162e62c2e11649cd03bc845b2a3dafe623b91065df69d47dc8e4f

doc/tezos-base/Tezos_base/Protocol/index.html

Module Tezos_base.ProtocolSource

Sourcetype t = {
  1. expected_env : env_version;
  2. components : component list;
}
Sourceand component = {
  1. name : string;
  2. interface : string option;
  3. implementation : string;
}
Sourceand env_version =
  1. | V0
  2. | V1
  3. | V2
  4. | V3
  5. | V4
  6. | V5
  7. | V6
  8. | V7
  9. | V8
  10. | V9
Sourceval component_encoding : component Data_encoding.t
Sourceval compare_version : env_version -> env_version -> int

compare_version va vb is negative if va is a less recent version than vb, positive if va is a more recent version than vb, zero if they are the same version.

In less precise but more intuitive terms, compare_version va vb <op> 0 is the same truthness as va <op> vb where <op> is any comparison operator.

E.g., compare_version V0 V1 < 0 is true.

Sourceval env_version_encoding : env_version Data_encoding.t
Sourceval pp_ocaml : Format.formatter -> t -> unit
include S.HASHABLE with type t := t and type hash := Tezos_crypto.Hashed.Protocol_hash.t
include S.T with type t := t
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 pp : Format.formatter -> t -> unit
Sourceval encoding : t Data_encoding.t
Sourceval to_bytes : t -> Bytes.t
Sourceval of_bytes : Bytes.t -> t option
Sourceval of_bytes_exn : Bytes.t -> t
Sourceval of_string_exn : String.t -> t
Sourceval of_string : String.t -> t option
Sourceval bounded_encoding : ?max_size:int -> unit -> t Data_encoding.t
Sourceval module_name_of_env_version : env_version -> string
Sourcemodule Meta : sig ... end