package tezos-protocol-alpha

You can search for identifiers within the package.

in-package search v0.2.0

Tezos protocol alpha package

Install

Dune Dependency

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

Authors

T

Tezos devteam

Maintainers

C

contact@tezos.com

Sources

octez-19.0.tar.gz

sha256=c6df840ebbf115e454db949028c595bec558a59a66cade73b52a6d099d6fa4d4

sha512=d8aee903b9fe130d73176bc8ec38b78c9ff65317da3cb4f3415f09af0c625b4384e7498201fdb61aa39086a7d5d409d0ab3423f9bc3ab989a680cf444a79bc13

doc/tezos_raw_protocol_alpha/Tezos_raw_protocol_alpha/Slot_repr/index.html

Module `Tezos_raw_protocol_alpha.Slot_repr`Source

Slot index representation

Abstract type

type t

A slot index is in essence a bounded whole number. That is, it is not allowed to overflow max_value, nor does it wrap when calling succ max_value. In this case it returns an Invalid_slot error.

Sourcetype slot = t

Sourceval encoding : t Tezos_protocol_environment_alpha.Data_encoding.t

Constructors

Sourceval zero : t

Sourceval max_value : t

Upper bound on the value a slot index can take

Sourceval of_int : int -> t Tezos_protocol_environment_alpha.Error_monad.tzresult

of_int i creates a slot index from integer i.

returns
Error (Invalid_slot i) if i < 0 || i > max_value, and Ok slot otherwise

Sourceval of_int_do_not_use_except_for_parameters : int -> t

of_int_do_not_use_except_for_parameters i is an unchecked construction function.

It may be used in cases where one knows 0 <= i <= max_value, e.g., when creating protocol parameters.

When in doubt, use of_int or of_int_exn.

Operator and pretty-printer

Sourceval succ : t -> t Tezos_protocol_environment_alpha.Error_monad.tzresult

succ n either returns an Invalid_slot error if n is max_value or ok value otherwise.

Conversion/Printing

Sourceval to_int : t -> int

to_int slot returns the integral representation of a slot index. This value is always a whole number.

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

Submodules

Sourcemodule Map : Tezos_protocol_environment_alpha.Map.S with type key = t

Sourcemodule Set : Tezos_protocol_environment_alpha.Set.S with type elt = t

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

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

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

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

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

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

val (>) : t -> t -> bool

val compare : t -> t -> int

val equal : t -> t -> bool

val max : t -> t -> t

val min : t -> t -> t

Sourcemodule Range : sig ... end

Sourcemodule Internal_for_tests : sig ... end

On This Page

Abstract type
Constructors
Operator and pretty-printer
Conversion/Printing
Submodules