package tezos-base

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Protocol time

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.p2p-identity-file
- Tezos_base_p2p_identity_file
  - Identity_file
tezos-base.unix
- Tezos_base_unix

Legend:
Library
Module
Module type
Parameter
Class
Class type

Protocol time

The out-of-protocol view of in-protocol timestamps. The precision of in-protocol timestamps are only precise to the second.

Note that the out-of-protocol view does not necessarily match the in-protocol representation.

type t

The type of protocol times

val epoch : t

Unix epoch is 1970-01-01 00:00:00 +0000 (UTC).

val min_rfc3339 : t

The first instant supported by RFC 3339, corresponds to 0000-01-01 00:00:00 +0000 (UTC).

val max_rfc3339 : t

The last instant supported by RFC 3339, corresponds to 9999-12-31 23:59:59 +0000 (UTC).

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 add : t -> int64 -> t

add t s is s seconds later than t

val diff : t -> t -> int64

diff a b is the number of seconds between a and b. It is negative if b is later than a.

Conversions to and from string representations

val of_notation : string -> t option

Convert a string in the RFC3339 format (e.g., "1970-01-01T00:00:00Z") into a protocol time. Invalid RFC3339 notations will return None.

Note that years outside the 0000-9999 range are invalid RFC3339-wise.

val of_notation_exn : string -> t

Convert a string in the RFC3339 format (e.g., "1970-01-01T00:00:00Z") into a protocol time. Invalid RFC3339 notations will raise Invalid_argument.

Note that years outside the 0000-9999 range are invalid RFC3339-wise.

val to_notation : t -> string

Convert a protocol time into an RFC3339 notation (e.g., "1970-01-01T00:00:00Z").

Note that years outside the 0000-9999 range will raise Invalid_argument as they are invalid RFC3339-wise.

Conversion to and from "number of seconds since epoch" representation.

val of_seconds : int64 -> t

Make a Protocol time from a number of seconds since the epoch.

val to_seconds : t -> int64

Convert a Protocol time into a number of seconds since the epoch.

Serialization functions

val encoding : t Data_encoding.t

Binary and JSON encoding.

Binary is always encoding/decoding as int64.

JSON is more complex (for backward compatibility and user-friendliness):

encoding uses the RFC3339 format (e.g., "1970-01-01T00:00:00Z") if the year is between 0000 and 9999 (RFC3339-compatible); otherwise it uses the int64 format
decoding tries to decode as an RFC3339 notation, and if it fails, it decodes as int64.

val rfc_encoding : t Data_encoding.t

Note: the RFC has a different range than the internal representation. Specifically, the RFC can only represent times between 0000-00-00 and 9999-12-31 (inclusive). The RFC-encoding fails for dates outside of this range.

For this reason, it is preferable to use encoding and only resort to rfc_encoding for human-readable format.

val rpc_arg : t Tezos_rpc.Arg.t

Pretty-printing functions

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

Pretty print as a number of seconds after epoch.

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

Note: pretty-printing uses the RFC3339 for human-readability. As mentioned in the comment on rfc_encoding, this representation fails when given dates too far in the future (after 9999-12-31) or the past (before 0000-00-00).

For reliable, generic pretty-printing use pp.