package tezos-base

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

tezos-base
- Tezos_base
  - Block_header
  - Block_locator
  - Bounded
    
    BOUNDS
    
    Int16
    
    B
    
    Int31
    
    B
    
    Int32
    
    B
    
    Int64
    
    B
    
    Int8
    
    B
    
    Non_negative_int32
    
    S
    
    Uint16
    
    B
    
    Uint8
    
    B
  - Dal_srs
  - Data_encoding_wrapper
  - Distributed_db_version
    
    Name
  - Fitness
  - Genesis
    
    Parameters
  - Internal_event_config
  - Mempool
  - Network_version
  - Operation
  - P2p_addr
  - P2p_connection
    
    Id
    
    Info
    
    Map
    
    P2p_event
    
    Set
    
    Table
  - P2p_identity
  - P2p_peer
    
    Error_table
    
    Filter
    
    Info
    
    Pool_event
    
    State
  - P2p_peer_id
    
    Error_table
    
    Map
    
    Set
    
    Table
    
    WeakRingTable
    
    H
  - P2p_point
    
    Filter
    
    Id
    
    Info
    
    Map
    
    Pool_event
    
    Set
    
    State
    
    Table
  - P2p_rejection
  - P2p_stat
  - P2p_version
  - Point_parser
  - Protocol
    
    Meta
  - S
    
    HASHABLE
    
    T
  - Sized
    
    MakeSizedMap
    
    Map
    
    MakeSizedSet
    
    Set
    
    SizedMap
    
    SizedSet
  - Test_chain_status
  - Time
    
    Protocol
    
    System
    
    Map
    
    Set
    
    Span
    
    Table
  - TzPervasives
    
    Bytes
    
    Empty
    
    Filename
    
    Infix
    
    Legacy_monad_globals
    
    List
    
    Lwt_result_syntax
    
    Lwt_syntax
    
    Result_syntax
    
    String
    
    Hashtbl
    
    Map
    
    Set
    
    TzTrace
    
    Wrapped_error_monad
  - User_activated
  - Worker_intf
    
    NAME
    
    REQUEST
    
    TYPES
    
    VIEW
  - Worker_types
tezos-base.unix
- Tezos_base_unix

Legend:
Library
Module
Module type
Parameter
Class
Class type

Allows to build interval of int integers representable on 2 bytes. The encoding used is Data_encoding.int16 regardless of the actual bounds.

raises Invalid_argument
if the bounds provided cannot be representable on 2 bytes.

Parameters

module B : BOUNDS with type ocaml_type := int

Signature

type 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

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

x = y iff compare x y = 0

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

x <> y iff compare x y <> 0

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

x < y iff compare x y < 0

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

x <= y iff compare x y <= 0

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

x >= y iff compare x y >= 0

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

x > y iff compare x y > 0

val compare : t -> t -> int

compare an alias for the functor parameter's compare function

val equal : t -> t -> bool

equal x y iff compare x y = 0

val max : t -> t -> t

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

val min : t -> t -> t

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

val 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.

val pp : Stdlib.Format.formatter -> t -> unit

A pretty-printer for values of type t.

val to_value : t -> int

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

val 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.